sourcescrub 0.0.7 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c425f778c050e471a59f52d8101bc7d5b2bd926e333292525ebe9ad67d4dce65
-  data.tar.gz: b98238083a2c65ec56cf6d45e82141c2b2f70a9ffde7eaa6be46a989f0c30a01
+  metadata.gz: 8631fba58663ed2b6340e63ac4dcbfdd387a07aa1192bb0ab911412071bf25f7
+  data.tar.gz: 446f9ebbbbe9fe5acf1eaef967c2b10983e3f5ce9c2362799e1071af34dcf9dd
 SHA512:
-  metadata.gz: b5b33a6b315e789588f09039cd5b62d1e038833019f2ada2b31b9eff4f99e967745db6a65698a5f4226e6bdaa3d47a62492d916e990f6ba3815a926da5526418
-  data.tar.gz: 17be5421cb1d3008de1248befc059f9e481424b966106a80afc4622f375e594ca65e98b071522b970955b2692d9634efd4f53e4d14db028bc6827b5aa3b042ec
+  metadata.gz: 54577a01f056d9414ffe17e72ff651e1bda42c4776ca9d820d672943a3e4f866fff933f80447feb96131932f8dadc28c132fb8a5da7149aee57bf893ee7c7d0b
+  data.tar.gz: 726091a74644fbf1f0b09dcd5b70f8a1d5f542796ea9f756a969487362b85744165dcf823b25f2f47c8f6385c53368a582fdcf8da1f58d29fc959fe19020e249

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## [0.1.2] - 2021-01-14
+
+- Implement search source endpoint to allow use filters to get matched sources - `client.source_search({limit: 10, offset: 0})`
+
+## [0.1.1] - 2020-11-03
+
+- Fixing wrong data issue of `currentEmployeeRange` in Company
+
+## [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.7)
+    sourcescrub (0.1.2)
       faraday
 
 GEM

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

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

data/lib/sourcescrub/client.rb

@@ -3,12 +3,14 @@
 require_relative './utils/request'
 require_relative './apis/companies'
 require_relative './apis/sources'
+require_relative './utils/search_params'
 
 # Root Sourcescrub
 module Sourcescrub
   # Client
   class Client
     include Utils::Request
+    include Utils::SearchParams
 
     attr_accessor :token
 
@@ -18,14 +20,24 @@ 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: company_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,
@@ -44,6 +56,15 @@ module Sourcescrub
       )
     end
 
+    def source_search(args = {})
+      api = source_search_api(source_params(args))
+
+      Models::SourceItems.new.parse_response_items(
+        api.kclass_name,
+        search(api.search_url, api.args)
+      )
+    end
+
     def sources(source_id, args = {})
       api = source_api(source_id, args)
 
@@ -62,22 +83,36 @@ module Sourcescrub
 
     private
 
-    def companies_api(domain, args)
-      @companies_api ||= Apis::Companies.new(
+    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)
-      @source_api ||= Apis::Sources.new(
+      Apis::Sources.new(
         source_id,
         { model_type: 'source' }.merge(args)
       )
     end
 
+    def source_search_api(args)
+      Apis::Sources.new(
+        nil,
+        { model_type: 'source' }.merge(args)
+      )
+    end
+
     def source_companies_api(source_id, args)
-      @source_companies_api ||= Apis::Sources.new(
+      Apis::Sources.new(
         source_id,
         { model_type: 'company' }.merge(args)
       )

data/lib/sourcescrub/utils/request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'logger'
 
 module Sourcescrub
   # Utils
@@ -19,32 +20,28 @@ module Sourcescrub
       #
       #
       def get(uri, *args)
-        response = Faraday.new(
-          url: API_URI,
-          headers: headers,
-          request: {
-            timeout: 10,
-            open_timeout: 5
-          }
-        ).get(uri, *args)
+        response = Faraday.new(request_options(args)) do |faraday|
+          faraday.headers['Content-Type'] = 'application/json-patch+json'
+          faraday.adapter Faraday.default_adapter
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+        end.get(uri)
 
-        response_body = response.body
-        raise Error, response_body unless response.status == 200
+        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)
+        parse_api_response(response.body).merge('headers' => response.headers)
+      end
+
+      # Search endpoints
+      def search(uri, args)
+        response = Faraday.new(request_options(args)) do |faraday|
+          faraday.headers['Content-Type'] = 'application/json-patch+json'
+          faraday.adapter Faraday.default_adapter
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+        end.post(uri, args.to_json)
+
+        raise Error, response.body unless response.status == 200
+
+        parse_api_response(response.body).merge('headers' => response.headers)
       end
 
       # def put(uri, args)
@@ -102,6 +99,31 @@ module Sourcescrub
 
       private
 
+      def request_options(args)
+        {
+          url: API_URI,
+          headers: headers,
+          request: {
+            timeout: 10,
+            open_timeout: 5
+          },
+          params: args[0] || {}
+        }
+      end
+
+      def parse_api_response(response_body)
+        response_body = JSON.parse(response_body)
+
+        # Processing different cases for investments
+        return response_body unless response_body.is_a?(Array)
+        return {} if response_body.empty?
+
+        {
+          'total' => response_body.size,
+          'items' => response_body
+        }
+      end
+
       def debug_mode?
         Sourcescrub.account.debug || false
       end

data/lib/sourcescrub/utils/response.rb

@@ -29,6 +29,7 @@ module Sourcescrub
         # Setup attributes
         attribute_names.each do |attr_name|
           attr_value = response.dig(attr_name)
+          attr_value = nil if attr_name == 'currentEmployeeRange' && attr_value.is_a?(Integer)
 
           dynamic_define_method(object, attr_name, attr_value)
         end

data/lib/sourcescrub/utils/search_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Sourcescrub
+  # Utilities
+  module Utils
+    # All Searches Parameters
+    module SearchParams
+      module_function
+
+      def source_params(args = {})
+        recursive_compact(build_args(args))
+      end
+
+      private
+
+      def build_args(args)
+        {
+          'filters' => {
+            'startDateRange' => {
+              'from' => args.dig(:start_date, :from),
+              'to' => args.dig(:start_date, :to)
+            },
+            'endDateRange' => {
+              'from' => args.dig(:end_date, :from),
+              'to' => args.dig(:end_date, :to)
+            },
+            'modifiedDateRange' => {
+              'from' => args.dig(:modified, :from),
+              'to' => args.dig(:modified, :to)
+            },
+            'completedAtDateRange' => {
+              'from' => args.dig(:completed_date, :from),
+              'to' => args.dig(:completed_date, :to)
+            },
+            'industries' => args.dig(:industries),
+            'statuses' => args.dig(:statuses),
+            'sourceTypes' => args.dig(:source_types),
+            'clientStatuses' => args.dig(:client_statuses),
+            'completedAt' => args.dig(:completed_at)
+          },
+          'searchText' => args.dig(:search_text),
+          'limit' => args.dig(:limit) || 100,
+          'offset' => args.dig(:offset) || 0,
+          'orderBy' => args.dig(:order_by) || 'endDate DESC'
+        }
+      end
+
+      def recursive_compact(hash_or_array)
+        block = proc do |*args|
+          v = args.last
+          v.delete_if(&block) if v.respond_to? :delete_if
+          v.nil? || v.respond_to?(:"empty?") && v.empty?
+        end
+
+        hash_or_array.delete_if(&block)
+      end
+    end
+  end
+end

data/lib/sourcescrub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourcescrub
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.2
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -120,6 +120,7 @@ files:
 - lib/sourcescrub/models/tag.rb
 - lib/sourcescrub/utils/request.rb
 - lib/sourcescrub/utils/response.rb
+- lib/sourcescrub/utils/search_params.rb
 - lib/sourcescrub/utils/ss_model.rb
 - lib/sourcescrub/utils/veriables.rb
 - lib/sourcescrub/version.rb