sourcescrub 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 107c70bcbc69c0b446ae0941bb148b73589cc8e1523d39e49a86db3747b6bf86
-  data.tar.gz: 1d8f9cd07245567aca8a939a337e0c9b5382ac2f818a35f289b9e4743b2d3e56
+  metadata.gz: 545d2b8b334ea07bbe2685f9a3b6d272aac07d1bf844b5193cd8253359365ba6
+  data.tar.gz: 49b57da12028f5755a3339451eda02029f65e66b5adb594d2b097434d526fa5f
 SHA512:
-  metadata.gz: 18acb6bd965321c23ff581d164bd155091675c3ba8ca1cf81d43a3e590477aa3c5c1cba0aaeaea17a5b077be811ce4474345ab75c513223e0845699718f5f829
-  data.tar.gz: df208a12a4ec65fae1372f4969321c0bff6ce859013989810095301d0c2fbc0927719db4dedaebe8efeadbe3019eb3c89771aaebc42703f24300f114548dcb08
+  metadata.gz: 1d75bb44c81093c2d4ce1a757a5c83741c8b7f0699625cb7551d17fb87b4828aec2e7515ccfc1a771d38de96c78aaa88f7d860c7782c051dd5f4185f3247a0f5
+  data.tar.gz: 8d2bf71686def7d5743d537babfab8eba380584aa0654dd33f92cbaac424b6e559df15e352da1aaae5856404b39335165e25a689b366631ddb328443f3dcc83d

data/.rubocop_todo.yml

@@ -22,3 +22,6 @@ Metrics/MethodLength:
 # URISchemes: http, https
 Layout/LineLength:
   Max: 135
+
+Metrics/BlockLength:
+  Max: 500

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 # Change Log
 
-## [0.0.1] - 2020-06-20
+## [0.0.3] - 2020-06-20
 
 - Implement API to request token by user certificate
-- Get company data by domain
+- Get company data by domain - `client.company(ekohe.com)`
+- Get company's relationship data by domain -  `client.company(ekohe.com, {card_id: 'people'})`
+- Retrieve request limit data from header
+
+```
+    #   .date
+    #   .content_type
+    #   .server
+    #   .content_length
+    #   .request_context
+    #   .strict_transport_security
+    #   .x_ratelimit_limit
+    #   .x_ratelimit_remaining
+    #   .x_ratelimit_reset
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sourcescrub (0.0.1)
+    sourcescrub (0.0.3)
       faraday
       faraday_middleware
 

data/README.md

@@ -4,6 +4,9 @@ Sourcescrub is a ruby wrapper based on Source Scrub API, Here is API documentati
 
 However, we need to request an access account from Sourcescrub.
 
+[![Gem Version](https://badge.fury.io/rb/sourcescrub.svg)](https://badge.fury.io/rb/sourcescrub)
+[![Build Status](https://travis-ci.org/ekohe/sourcescrub.svg?branch=master)](https://travis-ci.org/ekohe/sourcescrub)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -59,6 +62,7 @@ pry(main)> client.headers
 ```ruby
 <!-- Company -->
 response = client.companies('ekohe.com')
+response = client.company_cards('ekohe.com', { card_id: 'sources' })
 
 <!-- Get the JSON response of Company -->
 
@@ -71,6 +75,27 @@ response.as_json
 
 ```ruby
 pry(main)> response = client.companies('ekohe.com')
+pry(main)> #<Sourcescrub::Models::Company:0x00007fcd31bcd238
+ @city="Xinzhuang",
+ @companyType="Private",
+ @country="China",
+ @crunchbase=nil,
+ @currentEmployeeCount=41,
+ @currentEmployeeRange="11-50",
+ @currentJobOpenings=0,
+ @description=
+  "Ekohe, Ltd. is a cutting-edge web and mobile design and development agency. It specialize in digital strategy, innovative technology and user-centered design experiences from conceptualization to market launch.",
+ @domain="ekohe.com",
+ @facebook=nil,
+ @firmTags=[],
+ @foundingYear=2007,
+ @id="LZ281NVD",
+ @informalName="Ekohe",
+ @investors=nil,
+ @linkedIn="https://www.linkedin.com/company/ekohe",
+ @location="Xinzhuang, Shanghai Shi, China",
+ @name="Ekohe, Ltd.",
+ .....>
 pry(main)> response.name
 => "Ekohe, Ltd."
 pry(main)> response.domain
@@ -85,7 +110,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sourcescrub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sourcescrub/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ekohe/sourcescrub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ekohe/sourcescrub/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -94,4 +119,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Sourcescrub project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sourcescrub/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Sourcescrub project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ekohe/sourcescrub/blob/master/CODE_OF_CONDUCT.md).

data/lib/sourcescrub.rb

@@ -5,7 +5,9 @@ require 'sourcescrub/version'
 require 'sourcescrub/account'
 require 'sourcescrub/client'
 require 'sourcescrub/models'
+require 'sourcescrub/utils/veriables'
 
+# Sourcescrub
 module Sourcescrub
   TOKEN_URL = 'https://identity.sourcescrub.com'
   TOKEN_URI = '/connect/token'
@@ -14,5 +16,6 @@ module Sourcescrub
   API_URI   = 'https://api.sourcescrub.com/'
 
   class Error < StandardError; end
-  # Your code goes here...
+
+  include Utils::Veriables
 end

data/lib/sourcescrub/apis/companies.rb

@@ -21,7 +21,7 @@ module Sourcescrub
 
       def request_url
         [
-          kclass_name::ENDPOINT,
+          Models::Company::ENDPOINT,
           @domain,
           @card_id
         ].compact.join('/')

data/lib/sourcescrub/client.rb

@@ -17,16 +17,34 @@ module Sourcescrub
       { 'Authorization' => "Bearer #{@token}" }
     end
 
-    def companies(domain, args = {})
+    def company(domain, args = {})
       api = companies_api(domain, args)
 
       api.sobject.parse_response get(api.request_url, api.args)
     end
 
+    def company_cards(domain, args = {})
+      api = companies_api(domain, args.merge(model_type: card_mappings[args[:card_id]]))
+
+      Models::CompanyItems.new.parse_response_items(domain, api.kclass_name, get(api.request_url, api.args))
+    end
+
     private
 
     def companies_api(domain, args)
-      @companies_api || Apis::Companies.new(domain, args.merge(model_type: 'company'))
+      @companies_api || Apis::Companies.new(domain,
+                                            { model_type: 'company' }.merge(args))
+    end
+
+    def card_mappings
+      {
+        'sources' => 'source',
+        'people' => 'person',
+        'financials' => 'financial',
+        'investments' => 'investment',
+        'employees' => 'employee',
+        'tags' => 'tag'
+      }
     end
   end
 end

data/lib/sourcescrub/models.rb

@@ -3,9 +3,11 @@
 module Sourcescrub
   # Models
   module Models
-    autoload :Entity,   'sourcescrub/models/concerns/entity'
-    autoload :Company,  'sourcescrub/models/company'
-    autoload :Source,   'sourcescrub/models/source'
-    autoload :Tag,      'sourcescrub/models/tag'
+    autoload :Entity,           'sourcescrub/models/concerns/entity'
+    autoload :Company,          'sourcescrub/models/company'
+    autoload :CompanyItems,     'sourcescrub/models/concerns/company_items'
+    autoload :Source,           'sourcescrub/models/source'
+    autoload :Tag,              'sourcescrub/models/tag'
+    autoload :Person,           'sourcescrub/models/person'
   end
 end

data/lib/sourcescrub/models/concerns/company_items.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Tag
+    class CompanyItems < Entity
+      attr_accessor :domain, :total, :items, :type
+
+      def parse_response_items(domain, kclass_name, response)
+        headers = response.dig('headers')
+        headers&.keys&.each do |attr_name|
+          self.class.send(:define_method, attr_name.gsub('-', '_').to_sym) do
+            headers[attr_name]
+          end
+        end
+
+        dynamic_define_method(self, 'domain', domain)
+        dynamic_define_method(self, 'type', kclass_name)
+        dynamic_define_method(self, 'total', response.dig(total_key))
+        dynamic_define_method(self, 'items', company_items(kclass_name, response.dig(items_key)))
+        self
+      end
+
+      private
+
+      def company_items(kclass_name, items)
+        items.each_with_object([]) do |item, results|
+          results << kclass_name.new.parse_response(item)
+        end
+      end
+
+      def total_key
+        case type_name
+        when 'Person'
+          'totalPeople'
+        else
+          'total'
+        end
+      end
+
+      def items_key
+        case type_name
+        when 'Person'
+          'peopleAllocations'
+        else
+          'items'
+        end
+      end
+
+      def type_name
+        type.name.split('::')[-1]
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/employee.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Employee
+    class Employee < Entity
+      ENDPOINT = 'employees'
+
+      def field_ids
+        %w[
+          count
+          date
+        ]
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/financial.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Financial
+    class Financial < Entity
+      ENDPOINT = 'financials'
+
+      def field_ids
+        %w[
+          year
+          revenue
+          growth
+          growthTimePeriod
+        ]
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/investment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Investment
+    class Investment < Entity
+      ENDPOINT = 'investments'
+
+      def field_ids
+        %w[
+          amount
+          dateOfRaise
+          round
+          investors
+          valuation
+        ]
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/person.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Person
+    class Person < Entity
+      ENDPOINT = 'people'
+
+      def field_ids
+        %w[
+          personId
+          firstName
+          firstName
+          lastName
+          linkedIn
+          startDate
+          endDate
+          email
+          emailConfirmed
+          title
+          role
+        ]
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/source.rb

@@ -23,6 +23,9 @@ module Sourcescrub
           companyCount
           companiesCrmCount
           companiesTaggedCount
+          boothNumber
+          affiliation
+          rank
         ]
       end
     end

data/lib/sourcescrub/utils/request.rb

@@ -21,43 +21,48 @@ module Sourcescrub
       #
       #
       def get(uri, *args)
-        response = Faraday.new(url: API_URI) do |faraday|
-          faraday.headers = headers
-          faraday.request   :json
-          faraday.response  :json
-          faraday.response  :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+        response = Faraday.new(
+          url: API_URI,
+          headers: headers,
+          request: {
+            timeout: 10,
+            open_timeout: 5
+          }
+        ) do |faraday|
+          faraday.response :json
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
         end.get(uri, *args)
 
-        return response.body if response.status == 200
+        return response.body.merge('headers' => response.headers) if response.status == 200
 
         raise Error, response.body
       end
 
-      def put(uri, args)
-        response = Faraday.new(url: API_URI) do |faraday|
-          faraday.headers = headers
-          faraday.request   :json
-          faraday.response  :json
-          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
-        end.put(uri, args)
+      # def put(uri, args)
+      #   response = Faraday.new(url: API_URI) do |faraday|
+      #     faraday.headers = headers
+      #     faraday.request   :json
+      #     faraday.response  :json
+      #     faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+      #   end.put(uri, args)
 
-        return response.body if response.status == 200
+      #   return response.body if response.status == 200
 
-        raise Error, response.body
-      end
+      #   raise Error, response.body
+      # end
 
-      def delete(uri, args)
-        response = Faraday.new(url: API_URI) do |faraday|
-          faraday.headers = headers
-          faraday.request   :json
-          faraday.response  :json
-          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
-        end.delete(uri, args)
+      # def delete(uri, args)
+      #   response = Faraday.new(url: API_URI) do |faraday|
+      #     faraday.headers = headers
+      #     faraday.request   :json
+      #     faraday.response  :json
+      #     faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+      #   end.delete(uri, args)
 
-        return response.body if response.status == 200
+      #   return response.body if response.status == 200
 
-        raise Error, response.body
-      end
+      #   raise Error, response.body
+      # end
 
       # Authentication Token
       #
@@ -73,18 +78,19 @@ module Sourcescrub
       def authenticate
         body = "grant_type=password&username=#{Sourcescrub.account.username}&password=#{Sourcescrub.account.password}&scope=client_api"
 
-        response = Faraday.new(url: TOKEN_URL) do |faraday|
-          faraday.headers = {
+        response = Faraday.new(
+          url: TOKEN_URL,
+          headers: {
             'Content-Type' => 'application/x-www-form-urlencoded',
             'Authorization' => Sourcescrub.account.basic
           }
-          faraday.adapter   Faraday.default_adapter
-          faraday.request   :json
-          faraday.response  :json
+        ) do |faraday|
+          faraday.adapter Faraday.default_adapter
+          faraday.response :json
           faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
         end.post(TOKEN_URI, body)
 
-        raise 'Apptopia error: Service Unavailable' unless response.status == 200
+        raise 'Sourcescrub error: Service Unavailable' unless response.status == 200
 
         @token = response.body['access_token']
       end

data/lib/sourcescrub/utils/response.rb

@@ -8,6 +8,25 @@ module Sourcescrub
       module_function
 
       def dynamic_attributes(object, attribute_names, response)
+        # Retrieve request limit data from header
+        #
+        #   .date
+        #   .content_type
+        #   .server
+        #   .content_length
+        #   .request_context
+        #   .strict_transport_security
+        #   .x_ratelimit_limit
+        #   .x_ratelimit_remaining
+        #   .x_ratelimit_reset
+        headers = response.dig('headers')
+        headers&.keys&.each do |attr_name|
+          object.class.send(:define_method, attr_name.gsub('-', '_').to_sym) do
+            headers[attr_name]
+          end
+        end
+
+        # Setup attributes
         attribute_names.each do |attr_name|
           attr_value = response.dig(attr_name)
 

data/lib/sourcescrub/utils/veriables.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Utils
+  module Utils
+    # Veriables
+    module Veriables
+      # Description of operators
+      PEOPLE_ROLES = {
+        'founder' => 'Founder',
+        'employee' => 'Employee',
+        'board_member' => 'Board Member',
+        'advisor' => 'Advisor'
+      }.freeze
+    end
+  end
+end

data/lib/sourcescrub/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sourcescrub
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sourcescrub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Encore Shao
@@ -121,12 +121,18 @@ files:
 - lib/sourcescrub/client.rb
 - lib/sourcescrub/models.rb
 - lib/sourcescrub/models/company.rb
+- lib/sourcescrub/models/concerns/company_items.rb
 - lib/sourcescrub/models/concerns/entity.rb
+- lib/sourcescrub/models/employee.rb
+- lib/sourcescrub/models/financial.rb
+- lib/sourcescrub/models/investment.rb
+- lib/sourcescrub/models/person.rb
 - lib/sourcescrub/models/source.rb
 - lib/sourcescrub/models/tag.rb
 - lib/sourcescrub/utils/request.rb
 - lib/sourcescrub/utils/response.rb
 - lib/sourcescrub/utils/ss_model.rb
+- lib/sourcescrub/utils/veriables.rb
 - lib/sourcescrub/version.rb
 - sourcescrub.gemspec
 homepage: https://github.com/ekohe/sourcescrub