sourcescrub 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8afd87f86978b44cc34f969d64732c9599feb55d374e30a6b8744df9cac9d59d
-  data.tar.gz: f23474e047b16466cd1c70c86bc93d2e773f633f31acbd4100110ac10ee1f2e0
+  metadata.gz: 4980e44a9b4c4a87dec3bd316dc8de553db7a6d51290660ecf6c186ad28b4b6f
+  data.tar.gz: 8f919568a28e03bfa1256e1582581d4631b89b8d51395e6468e5d546683d5155
 SHA512:
-  metadata.gz: 70c3bdf3d103542aa9e54e40ddff7058013823a3138a391356a1de7880f01ab0f0696a2184bf8b89ab722637c179556b604ea7e0fcbaf74c6006a90f2bbd2588
-  data.tar.gz: '09a723173d5387952e8826d511d8ce9e76a63de200f165f4a3c592bd5d91724bbce9196e2f5447ddf30186f74dc742f34dc83e805fe6ca95e68b87fa2ad51c74'
+  metadata.gz: f0dd2c6d24b3ba995ae93a327b42b80f2cad1bf94b7a1aefbecf8c6b96be0163ad78dd447f1686ee66409f4c2209b1374ed63310e54c67fcb0377e2769f287de
+  data.tar.gz: 32c0d749fbd12014cb60a9f98ca35a78b63a13045483f265ec3cf9cf0b8966ab214f4089de855f2bce868cb036d8866865dc26f23c121eb851aa4613db1ee097

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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sourcescrub (0.0.5)
+    sourcescrub (0.1.0)
       faraday
 
 GEM

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
@@ -17,33 +18,97 @@ module Sourcescrub
       { '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)
+      Apis::Companies.new(
+        nil,
+        { model_type: 'company' }.merge(args)
+      )
+    end
+
+    def company_api(domain, args)
+      Apis::Companies.new(
+        domain,
+        { model_type: 'company' }.merge(args)
+      )
+    end
+
+    def source_api(source_id, args)
+      Apis::Sources.new(
+        source_id,
+        { model_type: 'source' }.merge(args)
+      )
+    end
+
+    def source_companies_api(source_id, args)
+      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,9 +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/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

@@ -25,17 +25,27 @@ module Sourcescrub
           request: {
             timeout: 10,
             open_timeout: 5
-          }
-        ).get(uri, *args)
-
-        response_body = JSON.parse(response.body)
-        if response.status == 200
-          response_body = {} if response_body.is_a?(Array) && response_body.empty?
-
-          return response_body.merge('headers' => response.headers)
+          },
+          params: args[0] || {}
+        ).get(uri)
+
+        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
 
-        raise Error, response_body
+        response_body.merge('headers' => response.headers)
       end
 
       # def put(uri, args)

data/lib/sourcescrub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourcescrub
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-03 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,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