Replaced hard-coded values with live Charity Commission data

Addresses #2

An org's charity number is used to pull details from CharityBase (E&W only) and Find That Charity to populate the `organisation#show` view.

Where we don't know an org's charity number, we look up its domain in the `charity_domain_lookups` table (imported from CSV)

Author: jdudley1123

Gemfile

@@ -62,3 +62,4 @@ gem 'airrecord', '~> 1.0.5'
 gem 'devise', '~> 4.7.1'
 gem 'google_drive', '~> 3.0.5'
 gem 'strong_password', '~> 0.0.8'
+gem 'faraday'

Gemfile.lock

@@ -101,7 +101,7 @@ GEM
     ffi (1.13.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    google-api-client (0.40.0)
+    google-api-client (0.40.1)
       addressable (~> 2.5, >= 2.5.1)
       googleauth (~> 0.9)
       httpclient (>= 2.8.1, < 3.0)
@@ -201,7 +201,7 @@ GEM
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (1.7.0)
+    regexp_parser (1.7.1)
     representable (3.0.4)
       declarative (< 0.1.0)
       declarative-option (< 0.2.0)
@@ -213,7 +213,7 @@ GEM
     reverse_markdown (2.0.0)
       nokogiri
     rexml (3.2.4)
-    rubocop (0.85.0)
+    rubocop (0.85.1)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
@@ -278,6 +278,8 @@ GEM
     turbolinks-source (5.2.0)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
+    tzinfo-data (1.2020.1)
+      tzinfo (>= 1.0.0)
     uber (0.1.0)
     unicode-display_width (1.7.0)
     warden (1.2.8)
@@ -313,6 +315,7 @@ DEPENDENCIES
   capybara (>= 2.15)
   devise (~> 4.7.1)
   dotenv-rails (~> 2.7.5)
+  faraday
   google_drive (~> 3.0.5)
   jbuilder (~> 2.7)
   letter_opener (~> 1.7.0)

app/controllers/organisations_controller.rb

@@ -9,5 +9,6 @@ def index
 
   def show
     @organisation = Organisation.includes(:users).find_by(id: params[:id])
+    @organisation.fetch_cc_data
   end
 end

app/models/charity_domain_lookup.rb

@@ -0,0 +1,46 @@
+class CharityDomainLookup < ApplicationRecord
+
+  def self.lookup_domain(domain)
+    generic_domains = [
+      'gmail.com',
+      'hotmail.com',
+      'btinternet.com',
+      'hotmail.co.uk',
+      'yahoo.co.uk',
+      'outlook.com',
+      'aol.com',
+      'btconnect.com',
+      'yahoo.com',
+      'googlemail.com',
+      'ntlworld.com',
+      'talktalk.net',
+      'sky.com',
+      'live.co.uk',
+      'ntlworld.com',
+      'tiscali.co.uk',
+      'icloud.com',
+      'btopenworld.com',
+      'blueyonder.co.uk',
+      'virginmedia.com',
+      'nhs.net',
+      'me.com',
+      'msn.com',
+      'talk21.com',
+      'aol.co.uk',
+      'mail.com',
+      'live.com',
+      'virgin.net',
+      'ymail.com',
+      'mac.com',
+      'waitrose.com',
+      'gmail.co.uk'
+    ]
+
+    return nil if generic_domains.include? domain
+
+    @domains = self.where(email_domain: domain).or(self.where(web_domain: domain))
+
+    return nil if @domains.count == 0
+    @domains.first.regno
+  end
+end

app/models/organisation.rb

@@ -6,4 +6,84 @@ class Organisation < ApplicationRecord
   has_many :users, through: :affiliations, source: :individual, source_type: 'User', dependent: :destroy
   has_many :tickets
   has_many :actions
+
+  attr_accessor :employee_count, :volunteer_count, :income, :income_fy, :region, :beneficiary
+
+  def get_charity_number
+    return self.charity_number if self.charity_number
+
+    if (charity_number = CharityDomainLookup.lookup_domain(self.domain))
+      self.update!({ charity_number: charity_number })
+      return charity_number
+    end
+
+    nil
+  end
+
+  def fetch_cc_data
+    return unless get_charity_number
+
+    charity_no = get_charity_number.split('-').last.strip
+
+    ftc_resp = Faraday.get('https://findthatcharity.uk/charity/' + charity_no + '.json')
+    ftc_data = JSON.parse(ftc_resp.body)
+    self.company_number = !ftc_data['company_number'].empty? ? ftc_data['company_number'][0]['number'] : nil
+    self.income = ftc_data['latest_income']
+
+    return unless england_and_wales?
+
+    cb_form_params = {
+      query: 'query SearchCharities($num: [ID]) {
+                CHC {
+                  getCharities(filters: {
+                    id: $num
+                  }) {
+                    list(limit: 30) {
+                      id
+                      areas{
+                        name
+                      }
+                      beneficiaries {
+                        name
+                      }
+                      geo {
+                        postcode
+                        european_electoral_region
+                      }
+                      finances {
+                        income
+                        financialYear {
+                          begin
+                          end
+                        }
+                      }
+                      numPeople {
+                        employees
+                        volunteers
+                      }
+                    }
+                  }
+                }
+              }',
+      variables: {
+        num: charity_no
+      }
+    }
+    cb_resp = Faraday.post('https://charitybase.uk/api/graphql', cb_form_params.to_json, {
+                             'Content-Type' => 'application/json',
+                             'Authorization' => 'Apikey 41f6fde1-7ab2-47bd-a069-39112c1d4339'
+                           })
+    cb_data = JSON.parse(cb_resp.body)['data']['CHC']['getCharities']['list'][0]
+
+    self.employee_count = cb_data['numPeople']['employees']
+    self.volunteer_count = cb_data['numPeople']['volunteers']
+    self.income = cb_data['finances'][0]['income']
+    self.income_fy = Date.parse(cb_data['finances'][0]['financialYear']['end'])
+    self.region = cb_data['geo']['european_electoral_region']
+    self.beneficiary = cb_data['beneficiaries'][0]['name']
+  end
+
+  def england_and_wales?
+    get_charity_number.start_with?('GB-CHC')
+  end
 end

app/views/organisations/show.html.erb

@@ -83,64 +83,57 @@
                 Charity number
               </dt>
               <dd class="mt-1 text-sm leading-5 text-gray-900 sm:mt-0 sm:col-span-2">
-                123456
+                <%= @organisation.charity_number || '<em class="text-gray-600">Not known</em>'.html_safe %>
+                
+				<% if @organisation.charity_number %>
                 <ul class="border border-gray-200 rounded-md mt-2">
                   <li class="pl-3 pr-4 py-3 flex items-center justify-between text-sm leading-5 border-b">
                     <em class="ml-2 flex-1 w-0 truncate text-gray-600">
-                      Data for financial year ending 31 March 2019
+                      Data for financial year ending <%= @organisation.income_fy&.strftime("%e %B %Y") %>
                     </em>
                   </li>
                   <li class="pl-3 pr-4 py-3 flex items-center justify-between text-sm leading-5 border-b">
                     <div class="w-0 flex-1 flex items-center ml-2">
                         Employees
                     </div>
                     <div class="ml-4 flex-shrink-0">
-                      22
+                      <%= @organisation.employee_count || '<em class="text-gray-600">Not known</em>'.html_safe %>
                     </div>
                   </li>
                   <li class="pl-3 pr-4 py-3 flex items-center justify-between text-sm leading-5">
                     <div class="w-0 flex-1 flex items-center ml-2">
                         Volunteers
                     </div>
                     <div class="ml-4 flex-shrink-0">
-                      8
+                      <%= @organisation.volunteer_count || '<em class="text-gray-600">Not known</em>'.html_safe %>
                     </div>
                   </li>
                   <li class="pl-3 pr-4 py-3 flex items-center justify-between text-sm leading-5">
                     <div class="w-0 flex-1 flex items-center ml-2">
                         Income
                     </div>
                     <div class="ml-4 flex-shrink-0">
-                      £1,100,000
+                       <%= number_to_currency(@organisation.income, unit: '£', precision: 0) || '<em class="text-gray-600">Not known</em>'.html_safe %>
                     </div>
                   </li>
                 </ul>
+            	<% end %>
               </dd>
             </div>
             <div class="bg-gray-50 px-4 py-4 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
               <dt class="text-sm leading-5 font-medium text-gray-600">
                 Company number
               </dt>
               <dd class="mt-1 text-sm leading-5 text-gray-900 sm:mt-0 sm:col-span-2">
-                123456
+                <%= @organisation.company_number || '<em class="text-gray-600">Not known</em>'.html_safe %>
               </dd>
             </div>
             <div class="bg-gray-50 px-4 py-4 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
               <dt class="text-sm leading-5 font-medium text-gray-600">
                 Location
               </dt>
               <dd class="mt-1 text-sm leading-5 text-gray-900 sm:mt-0 sm:col-span-2">
-                <select>
-                  <option>East Midlands</option>
-                  <option>East of England</option>
-                  <option>London</option>
-                  <option>North East</option>
-                  <option>North West</option>
-                  <option>South East</option>
-                  <option>South West</option>
-                  <option>West Midlands</option>
-                  <option>Yorkshire and The Humber</option>
-                </select>
+                <%= @organisation.region %>
                 <details class="text-xs text-gray-600">
                   <summary class="link">Dev notes</summary>
                   <p>
@@ -181,7 +174,7 @@
             </div>
             <div class="bg-white px-4 py-4 sm:grid sm:grid-cols-3 sm:gap-4 sm:px-6">
               <dt class="text-sm leading-5 font-medium text-gray-600">
-                COVID-19 Theme & Catagory
+                COVID-19 Theme &amp; Category
               </dt>
               <dd class="mt-1 text-sm leading-5 text-gray-900 sm:mt-0 sm:col-span-2">
                 <select class="w-full">
@@ -343,7 +336,7 @@
         </div>
         <%- @organisation.actions.each do |action| %>
           <div class="border-b border-gray-200 px-6 py-4 text-sm leading-5 font-medium text-gray-900">
-            <b><%= action.start_time.strftime("%Y %b %d") %>:</b> <%= action.getString() %>
+            <b><%= action.start_time.strftime("%Y %b %d") %>:</b> <%= action.get_string() %>
           </div>
         <% end %>
       </div>

db/migrate/20200608143625_create_charity_domain_lookups.rb

@@ -0,0 +1,11 @@
+class CreateCharityDomainLookups < ActiveRecord::Migration[6.0]
+  def change
+    create_table :charity_domain_lookups do |t|
+      t.string :regno
+      t.string :name
+      t.string :domain
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20200609085807_create_people.rb

@@ -0,0 +1,12 @@
+class CreatePeople < ActiveRecord::Migration[6.0]
+  def change
+    create_table :people do |t|
+      t.string :first_name
+      t.string :last_name
+      t.string :email
+      t.references :organisation, null: false, foreign_key: true
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20200609090224_add_person_to_action.rb

@@ -0,0 +1,5 @@
+class AddPersonToAction < ActiveRecord::Migration[6.0]
+  def change
+    add_reference :actions, :person, null: true, foreign_key: true
+  end
+end

db/migrate/20200609103110_add_columns_to_organisation.rb

@@ -0,0 +1,11 @@
+class AddColumnsToOrganisation < ActiveRecord::Migration[6.0]
+  def change
+    add_column :organisations, :charity_number, :string
+    add_column :organisations, :company_number, :string
+    add_column :organisations, :location, :jsonb
+    add_column :organisations, :audience, :string
+    add_column :organisations, :subsector, :jsonb
+    add_column :organisations, :maturity, :int
+    add_column :organisations, :anchor_org, :bool
+  end
+end