sourcescrub 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2884125ab5a2d684096e4c2a1107ae6f561671f4122cc7cf34962b74f9e51b64
-  data.tar.gz: d34e3f88743020e0eb49d4a7acadeb2fe0451d6742fcbcf1651b5eee08ad3494
+  metadata.gz: 7d8b09fea67b65e3ff5d2d8effb6d62a695a414b3b6f650561e2c261a0071d3f
+  data.tar.gz: 2746a0d58773997be22eab5c4b50bb01118bad06f9c149a7f4de86aa77f314af
 SHA512:
-  metadata.gz: a0e4aca28751dbaa64568bbe53ddfae988c538b117d059d66ce5b9c2f37a13119616f2ad6d8d6e3b99d0110796eac6f0a7515e5a43cc03f184fce33c618229f7
-  data.tar.gz: 9c8b1e392af7cc0bbd09d81cd6421f115503deb2872a49a58ea9e1ac4efd30c0e0b6be4a439f67dcee80ef415508d9b0972b042e6edda09fa44695b2d4b021cf
+  metadata.gz: e460c9f06ed36b2806d808d3360eaba605e3d43254699e0c284a210bde657e6e1f7c54e18e580fa7e9a1075b51510c3071a109af58e0807770f414dfbe868468
+  data.tar.gz: 45f1be48446d80daa3b11f4f15d604ea9b840d1c42d256bcbf6b7018f3d26ff720cfd820c9c8a20f5c5157ebd6dd9cfdceb17b3ab4ae1f1a67512a428c8da7c7

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## [0.1.3] - 2024-06-17
+
+- Get company data by SS ID - `client.company('XWO6N4OP')`
+- Pull new fields of company
+    - threeMonthsGrowthRate
+    - sixMonthsGrowthRate
+    - nineMonthsGrowthRate
+    - twelveMonthsGrowthRate
+    - growthIntent
+    - customScore
+    - industries
+    - modifiedDate
+    - endMarkets
+    - productsAndServices
+
+## [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
@@ -17,8 +36,8 @@
 ## [0.0.3] - 2020-06-20
 
 - Implement API to request token by user certificate
-- Get company data by domain - `client.company(ekohe.com)`
-- Get company's relationship data by domain -  `client.company(ekohe.com, {card_id: 'people'})`
+- 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
 
 ```

data/Gemfile.lock

@@ -1,35 +1,38 @@
 PATH
   remote: .
   specs:
-    sourcescrub (0.1.1)
+    sourcescrub (0.1.3)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
+    base64 (0.2.0)
     coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.8.1)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
     hashdiff (1.0.1)
     method_source (1.0.0)
-    multipart-post (2.1.1)
     parallel (1.19.2)
     parser (2.7.1.3)
       ast (~> 2.4.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (12.3.3)
     regexp_parser (1.7.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -55,6 +58,7 @@ GEM
     rubocop-ast (0.0.3)
       parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.5)
     safe_yaml (1.0.5)
     unicode-display_width (1.7.0)
     vcr (6.0.0)

data/README.md

@@ -61,7 +61,8 @@ pry(main)> client.headers
 
 ```ruby
 <!-- Company -->
-response = client.company('ekohe.com')
+response = client.company('ekohe.com') # get data by domain
+response = client.company('LZ281NVD') # get data by SS ID
 
 <!-- Get the JSON response of Company -->
 
@@ -70,7 +71,7 @@ response.as_json
 
 ### Companies
 
-####  Get the company data
+####  Get the company data by domain or Sourcescrub ID
 
 ```ruby
 pry(main)> response = client.company('ekohe.com')
@@ -179,6 +180,7 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+- [Encore](https://github.com/encoreshao)
 
 ## License
 

data/lib/sourcescrub/apis/companies.rb

@@ -12,8 +12,8 @@ module Sourcescrub
 
       attr_accessor :args
 
-      def initialize(domain, args)
-        @domain     = domain
+      def initialize(identifier, args)
+        @identifier = identifier
         @model_type = args.delete(:model_type)
         @card_id    = args.delete(:card_id)
         @args       = args
@@ -22,7 +22,7 @@ module Sourcescrub
       def request_url
         [
           Models::Company::ENDPOINT,
-          @domain,
+          @identifier,
           @card_id
         ].compact.join('/')
       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
 
@@ -28,17 +30,17 @@ module Sourcescrub
       )
     end
 
-    def company(domain, args = {})
-      api = company_api(domain, args)
+    def company(identifier, args = {})
+      api = company_api(identifier, args)
 
       api.sobject.parse_response get(api.request_url, api.args)
     end
 
-    def company_cards(domain, args = {})
-      api = company_api(domain, args.merge(model_type: company_card_mappings[args[:card_id]]))
+    def company_cards(identifier, args = {})
+      api = company_api(identifier, args.merge(model_type: company_card_mappings[args[:card_id]]))
 
       Models::CompanyItems.new.parse_response_items(
-        domain,
+        identifier,
         api.kclass_name,
         get(api.request_url, api.args)
       )
@@ -54,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)
 
@@ -79,9 +90,9 @@ module Sourcescrub
       )
     end
 
-    def company_api(domain, args)
+    def company_api(identifier, args)
       Apis::Companies.new(
-        domain,
+        identifier,
         { model_type: 'company' }.merge(args)
       )
     end
@@ -93,6 +104,13 @@ module Sourcescrub
       )
     end
 
+    def source_search_api(args)
+      Apis::Sources.new(
+        nil,
+        { model_type: 'source' }.merge(args)
+      )
+    end
+
     def source_companies_api(source_id, args)
       Apis::Sources.new(
         source_id,

data/lib/sourcescrub/models/company.rb

@@ -8,6 +8,7 @@ module Sourcescrub
     class Company < Entity
       ENDPOINT = 'companies'
 
+      # rubocop:disable Metrics/MethodLength
       def field_ids
         %w[
           id
@@ -32,13 +33,24 @@ module Sourcescrub
           linkedIn
           totalAmountInvested
           currentEmployeeCount
+          threeMonthsGrowthRate
+          sixMonthsGrowthRate
+          nineMonthsGrowthRate
+          twelveMonthsGrowthRate
           currentEmployeeRange
           currentJobOpenings
+          growthIntent
           investors
           personalTags
           firmTags
+          customScore
+          industries
+          modifiedDate
+          endMarkets
+          productsAndServices
         ]
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

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

@@ -5,9 +5,10 @@ module Sourcescrub
   module Models
     # Tag
     class CompanyItems < Entity
-      attr_accessor :domain, :total, :items, :type
+      attr_accessor :identifier, :total, :items, :type
 
-      def parse_response_items(domain, kclass_name, response)
+      # the identifier can be domain or SS ID
+      def parse_response_items(identifier, kclass_name, response)
         headers = response.dig('headers')
         headers&.keys&.each do |attr_name|
           self.class.send(:define_method, attr_name.gsub('-', '_').to_sym) do
@@ -15,7 +16,7 @@ module Sourcescrub
           end
         end
 
-        dynamic_define_method(self, 'domain', domain)
+        dynamic_define_method(self, 'identifier', identifier)
         dynamic_define_method(self, 'type', kclass_name)
         dynamic_define_method(self, 'total', response.dig(total_key) || 0)
         dynamic_define_method(self, 'items', company_items(kclass_name, response.dig(items_key) || []))

data/lib/sourcescrub/utils/request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'logger'
 
 module Sourcescrub
   # Utils
@@ -19,33 +20,28 @@ module Sourcescrub
       #
       #
       def get(uri, *args)
-        response = Faraday.new(
-          url: API_URI,
-          headers: headers,
-          request: {
-            timeout: 10,
-            open_timeout: 5
-          },
-          params: args[0] || {}
-        ).get(uri)
+        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)
@@ -103,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/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.1.1'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sourcescrub
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2024-06-17 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
@@ -147,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Sourcescrub is a ruby wrapper based on Source Scrub API.