sourcescrub 0.0.3 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 545d2b8b334ea07bbe2685f9a3b6d272aac07d1bf844b5193cd8253359365ba6
-  data.tar.gz: 49b57da12028f5755a3339451eda02029f65e66b5adb594d2b097434d526fa5f
+  metadata.gz: 3f41dea3cdbae246c59a9d375d31d5eff2f1897b09140415efc832a25efe52c2
+  data.tar.gz: 3ac121521449233ecca410aed6a1a6f3d8071f60162c2d9edc727a39284d9855
 SHA512:
-  metadata.gz: 1d75bb44c81093c2d4ce1a757a5c83741c8b7f0699625cb7551d17fb87b4828aec2e7515ccfc1a771d38de96c78aaa88f7d860c7782c051dd5f4185f3247a0f5
-  data.tar.gz: 8d2bf71686def7d5743d537babfab8eba380584aa0654dd33f92cbaac424b6e559df15e352da1aaae5856404b39335165e25a689b366631ddb328443f3dcc83d
+  metadata.gz: 5a08fc46e8376a96db5e1d32d5697f9a3b34f8190e7be90d84d5f3fb196f45ccf063953a56efd73b087608a4d19477a907ce7e8f69a2f4ec52ddc4a8314bd1ac
+  data.tar.gz: 759e47f3afd856181b36d79f7cb37e9894c35eca866087ef0d1266b9616c262b86764ac64f1084e5f1dee61ece13a14f617d00fd0c2350843ee936986c65c00b

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+
+## [0.0.8] - 2020-08-13
+
+- Implement API to request all compnies - `client.companies`
+
+## [0.0.7] - 2020-08-04
+
+- Get source data and source compaines - `client.source_companies(source_id)`
+- Get company's employeerange data by domain -  `client.company_cards('monday.com', { card_id: 'employeerange' })`
+- Get company's employees data by domain -  `client.company_cards('monday.com', { card_id: 'employees' })`
+
 ## [0.0.3] - 2020-06-20
 
 - Implement API to request token by user certificate

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    sourcescrub (0.0.3)
+    sourcescrub (0.0.8)
       faraday
-      faraday_middleware
 
 GEM
   remote: https://rubygems.org/
@@ -17,8 +16,6 @@ GEM
     diff-lcs (1.3)
     faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
     hashdiff (1.0.1)
     method_source (1.0.0)
     multipart-post (2.1.1)

data/README.md

@@ -61,8 +61,7 @@ pry(main)> client.headers
 
 ```ruby
 <!-- Company -->
-response = client.companies('ekohe.com')
-response = client.company_cards('ekohe.com', { card_id: 'sources' })
+response = client.company('ekohe.com')
 
 <!-- Get the JSON response of Company -->
 
@@ -74,8 +73,8 @@ response.as_json
 ####  Get the company data
 
 ```ruby
-pry(main)> response = client.companies('ekohe.com')
-pry(main)> #<Sourcescrub::Models::Company:0x00007fcd31bcd238
+pry(main)> response = client.company('ekohe.com')
+=> #<Sourcescrub::Models::Company:0x00007f9e915161c0
  @city="Xinzhuang",
  @companyType="Private",
  @country="China",
@@ -87,19 +86,87 @@ pry(main)> #<Sourcescrub::Models::Company:0x00007fcd31bcd238
   "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,
+=> #<Sourcescrub::Models::Company:0x00007f9e915161c0
+ @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 la
+unch.",
+ @domain="ekohe.com",
+ @facebook=nil,
  @firmTags=[],
  @foundingYear=2007,
  @id="LZ281NVD",
  @informalName="Ekohe",
- @investors=nil,
+ @investors="",
  @linkedIn="https://www.linkedin.com/company/ekohe",
  @location="Xinzhuang, Shanghai Shi, China",
  @name="Ekohe, Ltd.",
- .....>
+ @parentCompanyDomain=nil,
+ @personalTags=[],
+ @phoneNumber="",
+ @postalCode=nil,
+ @specialties=
+  ["IT & Startup Consulting",
+   "Ruby on Rails leaders",
+   "Intelligent Web & Mobile Development",
+   "Usable Web & Mobile design",
+   "UX or UI Design",
+   "Artificial Intelligence",
+   "Machine Learning",
+   "Data Sourcing",
+   "FinTech Tools"],
+ @state="Shanghai Shi",
+ @totalAmountInvested=0,
+ @twitter=nil,
+ @website="https://ekohe.com">
 pry(main)> response.name
 => "Ekohe, Ltd."
 pry(main)> response.domain
 => "ekohe.com"
+pry(main)> response.as_json
+=> {:id=>"LZ281NVD",
+ :companyType=>"Private",
+ :name=>"Ekohe, Ltd.",
+ :informalName=>"Ekohe",
+ :website=>"https://ekohe.com",
+ :domain=>"ekohe.com",
+ :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.",
+ :foundingYear=>2007,
+ :location=>"Xinzhuang, Shanghai Shi, China",
+ :city=>"Xinzhuang",
+ :state=>"Shanghai Shi",
+ :postalCode=>nil,
+ :country=>"China",
+ :parentCompanyDomain=>nil,
+ :phoneNumber=>"",
+ :specialties=>
+  ["IT & Startup Consulting",
+   "Ruby on Rails leaders",
+   "Intelligent Web & Mobile Development",
+   "Usable Web & Mobile design",
+   "UX or UI Design",
+   "Artificial Intelligence",
+   "Machine Learning",
+   "Data Sourcing",
+   "FinTech Tools"],
+ :facebook=>nil,
+ :twitter=>nil,
+ :crunchbase=>nil,
+ :linkedIn=>"https://www.linkedin.com/company/ekohe",
+ :totalAmountInvested=>0,
+ :currentEmployeeCount=>41,
+ :currentEmployeeRange=>"11-50",
+ :currentJobOpenings=>0,
+ :investors=>"",
+ :personalTags=>[],
+ :firmTags=>[]}
 ```
 
 ### Searches

data/lib/sourcescrub.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require 'sourcescrub/version'
 
 require 'sourcescrub/account'

data/lib/sourcescrub/apis/companies.rb

@@ -26,6 +26,13 @@ module Sourcescrub
           @card_id
         ].compact.join('/')
       end
+
+      def search_url
+        [
+          'search',
+          Models::Company::ENDPOINT
+        ].compact.join('/')
+      end
     end
   end
 end

data/lib/sourcescrub/apis/sources.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative './../utils/ss_model'
+
+# Root Sourcescrub
+module Sourcescrub
+  # Apis
+  module Apis
+    # Companies endpoint
+    class Sources
+      include ::Sourcescrub::Utils::SsModel
+
+      attr_accessor :args
+
+      def initialize(source_id, args)
+        @source_id  = source_id
+        @model_type = args.delete(:model_type)
+        @args       = args
+      end
+
+      def request_url
+        [
+          Models::Source::ENDPOINT,
+          @source_id
+        ].compact.join('/')
+      end
+
+      def companies_url
+        [
+          Models::Source::ENDPOINT,
+          @source_id,
+          'companies'
+        ].compact.join('/')
+      end
+    end
+  end
+end

data/lib/sourcescrub/client.rb

@@ -2,6 +2,7 @@
 
 require_relative './utils/request'
 require_relative './apis/companies'
+require_relative './apis/sources'
 
 # Root Sourcescrub
 module Sourcescrub
@@ -12,38 +13,102 @@ module Sourcescrub
     attr_accessor :token
 
     def headers
-      @token || authenticate
+      authenticate if @token.nil?
 
       { 'Authorization' => "Bearer #{@token}" }
     end
 
+    def companies(args = { limit: 100, offset: 0 })
+      api = companies_api(args)
+
+      Models::CompanyItems.new.parse_response_items(
+        nil,
+        api.kclass_name,
+        get(api.search_url, api.args)
+      )
+    end
+
     def company(domain, args = {})
-      api = companies_api(domain, args)
+      api = company_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]]))
+      api = company_api(domain, args.merge(model_type: company_card_mappings[args[:card_id]]))
+
+      Models::CompanyItems.new.parse_response_items(
+        domain,
+        api.kclass_name,
+        get(api.request_url, api.args)
+      )
+    end
 
-      Models::CompanyItems.new.parse_response_items(domain, api.kclass_name, get(api.request_url, api.args))
+    # The max limit range is 0 - 100
+    def all_sources(args = { sourceStatus: 'None', limit: 100, offset: 0 })
+      api = source_api('sources', args)
+
+      Models::SourceItems.new.parse_response_items(
+        api.kclass_name,
+        get(api.request_url, api.args)
+      )
+    end
+
+    def sources(source_id, args = {})
+      api = source_api(source_id, args)
+
+      api.sobject.parse_response get(api.request_url, api.args)
+    end
+
+    def source_companies(source_id, args = {})
+      api = source_companies_api(source_id, args)
+
+      Models::CompanyItems.new.parse_response_items(
+        source_id,
+        api.kclass_name,
+        get(api.companies_url, api.args)
+      )
     end
 
     private
 
-    def companies_api(domain, args)
-      @companies_api || Apis::Companies.new(domain,
-                                            { model_type: 'company' }.merge(args))
+    def companies_api(args)
+      @companies_api ||= Apis::Companies.new(
+        nil,
+        { model_type: 'company' }.merge(args)
+      )
+    end
+
+    def company_api(domain, args)
+      @company_api ||= Apis::Companies.new(
+        domain,
+        { model_type: 'company' }.merge(args)
+      )
+    end
+
+    def source_api(source_id, args)
+      @source_api ||= Apis::Sources.new(
+        source_id,
+        { model_type: 'source' }.merge(args)
+      )
+    end
+
+    def source_companies_api(source_id, args)
+      @source_companies_api ||= Apis::Sources.new(
+        source_id,
+        { model_type: 'company' }.merge(args)
+      )
     end
 
-    def card_mappings
+    def company_card_mappings
       {
         'sources' => 'source',
         'people' => 'person',
         'financials' => 'financial',
         'investments' => 'investment',
         'employees' => 'employee',
-        'tags' => 'tag'
+        'tags' => 'tag',
+        'employeerange' => 'employee_range'
       }
     end
   end

data/lib/sourcescrub/models.rb

@@ -6,8 +6,13 @@ module Sourcescrub
     autoload :Entity,           'sourcescrub/models/concerns/entity'
     autoload :Company,          'sourcescrub/models/company'
     autoload :CompanyItems,     'sourcescrub/models/concerns/company_items'
+    autoload :SourceItems,      'sourcescrub/models/concerns/source_items'
     autoload :Source,           'sourcescrub/models/source'
     autoload :Tag,              'sourcescrub/models/tag'
     autoload :Person,           'sourcescrub/models/person'
+    autoload :Financial,        'sourcescrub/models/financial'
+    autoload :Investment,       'sourcescrub/models/investment'
+    autoload :Employee,         'sourcescrub/models/employee'
+    autoload :EmployeeRange,    'sourcescrub/models/employee_range'
   end
 end

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

@@ -17,8 +17,8 @@ module Sourcescrub
 
         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)))
+        dynamic_define_method(self, 'total', response.dig(total_key) || 0)
+        dynamic_define_method(self, 'items', company_items(kclass_name, response.dig(items_key) || []))
         self
       end
 

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Models
+  module Models
+    # Tag
+    class SourceItems < Entity
+      attr_accessor :total, :items, :type
+
+      def parse_response_items(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, 'type', kclass_name)
+        dynamic_define_method(self, 'total', response.dig('total') || 0)
+        dynamic_define_method(self, 'items', source_items(kclass_name, response.dig('items') || []))
+        self
+      end
+
+      private
+
+      def source_items(kclass_name, items)
+        items.each_with_object([]) do |item, results|
+          results << kclass_name.new.parse_response(item)
+        end
+      end
+    end
+  end
+end

data/lib/sourcescrub/models/employee_range.rb

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

data/lib/sourcescrub/utils/request.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
-require 'logger'
 
 module Sourcescrub
   # Utils
@@ -28,14 +26,25 @@ module Sourcescrub
             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.merge('headers' => response.headers) if response.status == 200
-
-        raise Error, response.body
+        ).get(uri, *args)
+
+        response_body = response.body
+        raise Error, response_body unless response.status == 200
+
+        response_body = JSON.parse(response_body)
+        # Processing different cases for investments
+        if response_body.is_a?(Array)
+          response_body = if response_body.empty?
+                            {}
+                          else
+                            {
+                              'total' => response_body.size,
+                              'items' => response_body
+                            }
+                          end
+        end
+
+        response_body.merge('headers' => response.headers)
       end
 
       # def put(uri, args)
@@ -84,15 +93,11 @@ module Sourcescrub
             'Content-Type' => 'application/x-www-form-urlencoded',
             'Authorization' => Sourcescrub.account.basic
           }
-        ) 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)
+        ).post(TOKEN_URI, body)
 
         raise 'Sourcescrub error: Service Unavailable' unless response.status == 200
 
-        @token = response.body['access_token']
+        @token = JSON.parse(response.body)['access_token']
       end
 
       private

data/lib/sourcescrub/version.rb

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

data/sourcescrub.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
 
   # VCR for testing APIs
   spec.add_development_dependency 'vcr'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourcescrub
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.8
 platform: ruby
 authors:
 - Encore Shao
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -118,12 +104,15 @@ files:
 - lib/sourcescrub.rb
 - lib/sourcescrub/account.rb
 - lib/sourcescrub/apis/companies.rb
+- lib/sourcescrub/apis/sources.rb
 - 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/concerns/source_items.rb
 - lib/sourcescrub/models/employee.rb
+- lib/sourcescrub/models/employee_range.rb
 - lib/sourcescrub/models/financial.rb
 - lib/sourcescrub/models/investment.rb
 - lib/sourcescrub/models/person.rb
@@ -143,7 +132,7 @@ metadata:
   homepage_uri: https://github.com/ekohe/sourcescrub
   source_code_uri: https://github.com/ekohe/sourcescrub
   changelog_uri: https://github.com/ekohe/sourcescrub/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Sourcescrub is a ruby wrapper based on Source Scrub API.
 test_files: []