crunchbase4 0.1.5 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84f43d773473d40462a4eead8f4548aaa15eb10b2c5dff849b50d07f579fddf5
-  data.tar.gz: 7f34006abc99d5106cdf7a261adade5e72d8db7be3d68a1cbd3bccdfb8e1d10b
+  metadata.gz: 847ef68e0f7d78cb3ebeb25145c2e52381ee855a68709a6e9aa5a1f0d05b6a5d
+  data.tar.gz: 6be09a238a9412692e782d7c4540181da32c429cb5ad27cf5b7ebc4756a24b71
 SHA512:
-  metadata.gz: ab8418cc8cb8739460bb1335092dee1f9110e9453f4ab61bca6430ad0250251db887e5cf95637fb0d1f319030a4b16ad0e188c3c925b9c63ea1aa2fd257da25b
-  data.tar.gz: 67c78499a471c58315b1ff8d6c4abd5fe262dda55cfd2d67edf74be77d701a4e777db43cb1b6d38cb7d4cd1e0f6642b93b52f5608ee5df741830103378d5ff3d
+  metadata.gz: 6f9f84bf20a0f27108fc6ec17533d82de74a538c87545cdee661d22138ca5e7002f85de42ffc448943fada30cac5ea2cd632afb237af835b44724647a6c985e8
+  data.tar.gz: 76d2e72a670c8c35978e225604ee7b759e9910004f8d92bbf61c0ef86d563dc095a225ba5dafd4f2793c823108c96cfbeb3a0b61350c9f2380315836ae107bec

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Change Log
 
+## [0.1.9] - 2021-10-04
+
+### Allow to export Daily CSV bulk
+- Implement new API to export daily CSV bulk. related document https://data.crunchbase.com/docs/daily-csv-export
+  - download_bulk: (`client.download_bulk(dir, extract: true)`)
+
+## [0.1.8] - 2021-02-23
+
+### Add new fields on funding_rounds
+- Adding diversity_spotlights and pre_money_valuation on raised_funding_rounds endpoint
+
+## [0.1.7] - 2020-12-02
+
+### Improve press_reference API response for activity_entities
+- Returns relationship data for activity_entities
+    * Before returns all names for activity_entities
+    * After returns related organzation or person object
+
 ## [0.1.5] - 2020-06-26
 
 ### Refactoring
@@ -9,12 +27,12 @@
     * After
       - Get organzation's fund: (`client.organization(entity_id, card_id: 'fund')`)
 - Method for uniformly obtaining deleted entities data and support more query condition
-    * Get deleted organzations
-      - Before:  (`client.deleted_organzations`)
+    * Get deleted organizations
+      - Before:  (`client.deleted_organizations`)
       - After :  (`client.deleted_entities(collection_ids: 'organizations', limit: 20)`)
 - Method for uniformly obtaining autocompletes entities data and support more query condition
-    * Get autocompletes organzations
-      - Before:  (`client.autocomplete_organzations`)
+    * Get autocompletes organizations
+      - Before:  (`client.autocomplete_organizations`)
       - After :  (`client.autocomplete('ekohe', collection_ids: 'organizations', limit: 3)`)
 
 ## [0.1.4] - 2020-06-12
@@ -38,11 +56,11 @@
 
 ### Added
 - Implemented searches APIs to get the recent updates entities on Search
-  - organzations
+  - organizations
   - people
   - funding rounds
 - Implemented `autocompletes` API to allow user filter entities by keyword
-  - organzations
+  - organizations
   - people
   - funding rounds
 
@@ -50,7 +68,7 @@
 
 ### Added
 - Implemented APIs to get acquisition and investment of Entity
-- Implemented APIs to search organzations and funding rounds of Search
+- Implemented APIs to search organizations and funding rounds of Search
 
 ### Changed
 - Refactor the API client to support search API

data/Gemfile.lock

@@ -1,29 +1,54 @@
 PATH
   remote: .
   specs:
-    crunchbase4 (0.1.5)
+    crunchbase4 (0.1.8)
       faraday
       faraday_curl
       faraday_middleware
+      httparty
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     coderay (1.1.3)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    faraday (1.0.1)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
     faraday_curl (0.0.2)
       faraday (>= 0.9.0)
-    faraday_middleware (1.0.0)
+    faraday_middleware (1.1.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
     method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_xml (0.6.0)
     multipart-post (2.1.1)
     parallel (1.19.1)
     parser (2.7.1.3)
@@ -31,11 +56,11 @@ GEM
     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.0)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -61,6 +86,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)
@@ -82,4 +108,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.5

data/README.md

@@ -56,7 +56,7 @@ pry(main)> client = Crunchbase::Client.new
 - [Deleted Entities](https://github.com/ekohe/crunchbase4#deleted-entities)
 
 ```ruby
-<!-- Entity and Single Card -->
+<!-- Examples of organization and single card -->
 response                = client.organization('ekohe')
 ipos                    = client.organization('ekohe', card_id: 'ipos')
 fund                    = client.organization('ekohe', card_id: 'fund')
@@ -67,15 +67,25 @@ jobs                    = client.organization('ekohe', card_id: 'jobs')
 headquarters_address    = client.organization('ekohe', card_id: 'headquarters_address')
 top_2_press_references  = client.organization('ekohe', card_id: 'press_references', limit: 2)
 
+<!-- Examples to get the funding rounds of the organization through paging -->
+response = client.organization(
+  'facebook', card_id: 'participated_funding_rounds',
+  limit: 5,
+  order: 'announced_on:desc',
+  after_id: '3cdfcecd-5377-439b-acab-cefcf6fe21a5'
+)
+
+<!-- Examples of person and single card -->
+
 response = client.person('mark-zuckerberg')
 response = client.person('mark-zuckerberg', card_id: 'participated_investments')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247', card_id: 'investors')
+response = client.funding_round('3cdfcecd-5377-439b-acab-cefcf6fe21a5')
+response = client.funding_round('3cdfcecd-5377-439b-acab-cefcf6fe21a5', card_id: 'investors')
 response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
 response = client.fund('aeaac12b-df56-7039-40f9-f1992f88e20e')
 response = client.ownership('4506d9ce-85d3-4a8f-89cd-07a225359d55')
 
-<!-- Get the JSON response of Entity -->
+<!-- Get the JSON response of entity -->
 
 response.as_json
 
@@ -242,12 +252,87 @@ pry(main)> response.acquiree_funding_total
 
 ```ruby
 pry(main)> response = client.press_reference('0171b30e-9cf8-4ad5-8288-2993e4308e0f')
-=> #<Crunchbase::Models::PressReference:0x00007fce2d33dbc0
- @activity_entities=["Facebook", "General Atlantic", "KKR", "Reliance Industries", "Vista Equity Partners"],
+=> #<Crunchbase::Models::PressReference:0x00007fd6faf97800
+ @activity_entities=
+  [#<Crunchbase::Models::Organization:0x00007fd6fb41d9d8
+    @aliases=nil,
+    @description=nil,
+    @identifier=[],
+    @legal_name=nil,
+    @linkedin=nil,
+    @name="Facebook",
+    @permalink="facebook",
+    @permalink_aliases=nil,
+    @rank_org=nil,
+    @rank_org_company=nil,
+    @short_description=nil,
+    @twitter=nil,
+    @uuid="df662812-7f97-0b43-9d3e-12f64f504fbb",
+    @website=nil>,
+   #<Crunchbase::Models::Organization:0x00007fd6fb42f2c8
+    @aliases=nil,
+    @description=nil,
+    @identifier=[],
+    @legal_name=nil,
+    @linkedin=nil,
+    @name="General Atlantic",
+    @permalink="general-atlantic",
+    @permalink_aliases=nil,
+    @rank_org=nil,
+    @rank_org_company=nil,
+    @short_description=nil,
+    @twitter=nil,
+    @uuid="8b8d96f8-9dfe-b27a-8f57-7d266a051dc9",
+    @website=nil>,
+   #<Crunchbase::Models::Organization:0x00007fd6fb42da18
+    @aliases=nil,
+    @description=nil,
+    @identifier=[],
+    @legal_name=nil,
+    @linkedin=nil,
+    @name="Kohlberg Kravis Roberts",
+    @permalink="kkr",
+    @permalink_aliases=nil,
+    @rank_org=nil,
+    @rank_org_company=nil,
+    @short_description=nil,
+    @twitter=nil,
+    @uuid="6c93ebd7-3558-5603-daaf-074652d0e1bb",
+    @website=nil>,
+   #<Crunchbase::Models::Organization:0x00007fd6fb42c168
+    @aliases=nil,
+    @description=nil,
+    @identifier=[],
+    @legal_name=nil,
+    @linkedin=nil,
+    @name="Reliance Industries",
+    @permalink="reliance-industries-84fd",
+    @permalink_aliases=nil,
+    @rank_org=nil,
+    @rank_org_company=nil,
+    @short_description=nil,
+    @twitter=nil,
+    @uuid="7ba47aa0-0e01-4101-a74d-67a8205584fd",
+    @website=nil>,
+   #<Crunchbase::Models::Organization:0x00007fd6fb43e868
+    @aliases=nil,
+    @description=nil,
+    @identifier=[],
+    @legal_name=nil,
+    @linkedin=nil,
+    @name="Vista Equity Partners",
+    @permalink="vista-equity-partners",
+    @permalink_aliases=nil,
+    @rank_org=nil,
+    @rank_org_company=nil,
+    @short_description=nil,
+    @twitter=nil,
+    @uuid="4d096273-ae5d-d4c3-a411-20a42514d2ce",
+    @website=nil>],
  @author=nil,
  @created_at="2020-06-05T17:41:10Z",
  @entity_def_id="press_reference",
- @identifier="Jio Platforms to receive $1.2b from Abu Dhabi’s sovereign investment firm",
+ @identifier=["0171b30e-9cf8-4ad5-8288-2993e4308e0f", "Jio Platforms to receive $1.2b from Abu Dhabi’s sovereign investment firm"],
  @posted_on="2020-06-05",
  @publisher="Tech in Asia",
  @thumbnail_url="https://cdn.techinasia.com/wp-content/uploads/2016/07/Flickr_-_World_Economic_Forum_-_Ambani.jpg",
@@ -626,6 +711,17 @@ pry(main)> response = client.deleted_entities(collection_ids: 'people')
 pry(main)> response = client.deleted_entities(collection_ids: 'funding_rounds')
 ```
 
+### Daily CSV Export
+
+* https://api.crunchbase.com/bulk/v4/bulk_export.tar.gz?user_key=user_key
+
+
+```ruby
+pry(main)> response = client.download_bulk(dir, extract: true)
+```
+
+After running the download operation, you will see `bulk_export.tar.gz` in your provided folder.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/crunchbase4.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_curl'
   spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'httparty'
 
   # VCR for testing APIs
   spec.add_development_dependency 'vcr'

data/lib/crunchbase/client.rb

@@ -4,6 +4,7 @@ require_relative 'utilities/entity_endpoints'
 require_relative 'utilities/search_endpoints'
 require_relative 'utilities/autocomplete'
 require_relative 'utilities/deleted_entities'
+require_relative 'utilities/downloads'
 
 module Crunchbase
   # API Request
@@ -12,5 +13,6 @@ module Crunchbase
     include Utilities::SearchEndpoints
     include Utilities::Autocomplete
     include Utilities::DeletedEntities
+    include Utilities::Downloads
   end
 end

data/lib/crunchbase/config.rb

@@ -7,7 +7,7 @@ module Crunchbase
   # Config
   class Config
     include Singleton
-    attr_accessor :user_key, :debug
+    attr_accessor :user_key, :bulk_url, :debug
   end
 
   def self.config

data/lib/crunchbase/downloads/client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Crunchbase
+  # Zip file downloads endpoints
+  module Downloads
+    # using Crunchbase's downloads API endpoints
+    class Client
+      include HTTParty
+      # Will spit out all request details to the console
+      debug_output $stdout
+
+      def download_bulk(dir, extract: false)
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+        dist_path = Pathname.new(dir).join File.basename(bulk_url)
+
+        download(bulk_url, dist_path) unless File.exist?(dist_path)
+        system "tar xfz #{dist_path} -C #{dir}" if extract
+
+        dist_path
+      end
+
+      private
+
+      def bulk_url
+        Crunchbase.config.bulk_url || [API_DOMAIN, "/bulk/#{API_VERSION}/bulk_export.tar.gz"].join
+      end
+
+      def download(url, dist_path)
+        File.open(dist_path, 'w') do |file|
+          file.binmode
+          request(url, stream_body: true) do |buffer|
+            file.write(buffer)
+          end
+        end
+      end
+
+      def request(url, options = {}, &block)
+        default_options = { query: { user_key: Crunchbase.config.user_key } }
+        options.merge!(default_options)
+
+        response = self.class.get(url, options, &block)
+        response.content_type.match?(/json/) ? JSON.parse(response.body) : response
+      end
+    end
+  end
+end

data/lib/crunchbase/downloads.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Downloads
+  module Downloads
+    autoload :Client, 'crunchbase/downloads/client'
+  end
+end

data/lib/crunchbase/models/concerns/entity.rb

@@ -12,7 +12,7 @@ module Crunchbase
       include Mappings
 
       def fields
-        field_ids.map(&:to_sym)
+        field_ids.concat(custom_fields).map(&:to_sym)
       end
 
       def parse_response(response, request_field_ids = [], cards = [])
@@ -30,7 +30,7 @@ module Crunchbase
           card_objects = if card_data.is_a?(Array)
                            card_data.each_with_object([]) do |data, objects|
                              new_card_instance = card_model.new
-                             objects << dynamic_attributes(new_card_instance, new_card_instance.basis_fields, data)
+                             objects << dynamic_attributes(new_card_instance, new_card_instance.field_ids, data)
                            end
                          else
                            card_data.nil? ? nil : dynamic_attributes(card_model.new, extract_fields, data)
@@ -43,6 +43,12 @@ module Crunchbase
       def as_json
         fields.each_with_object({}) { |item, hash| hash[item] = send(item) }
       end
+
+      private
+
+      def custom_fields
+        []
+      end
     end
   end
 end

data/lib/crunchbase/models/funding_round.rb

@@ -18,6 +18,7 @@ module Crunchbase
           funded_organization_identifier
           funded_organization_location
           funded_organization_revenue_range
+          funded_organization_diversity_spotlights
           identifier
           image_id
           investor_identifiers

data/lib/crunchbase/models/organization.rb

@@ -134,6 +134,16 @@ module Crunchbase
           headquarters_address
         ]
       end
+
+      def employees_range
+        Crunchbase::Utils::NUM_EMPLOYEES_ENUM[num_employees_enum]
+      end
+
+      private
+
+      def custom_fields
+        %w[employees_range]
+      end
     end
   end
 end

data/lib/crunchbase/utilities/downloads.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../downloads/client'
+
+module Crunchbase
+  # Utilities
+  module Utilities
+    # Daily csv export
+    module Downloads
+      def download_bulk(dir, extract: false)
+        Crunchbase::Downloads::Client.new.download_bulk(dir, extract: extract)
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/response.rb

@@ -52,15 +52,37 @@ module Crunchbase
         %w[identifier]
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       def field_value(name, data)
         value = data.dig(name)
 
         return value if value.nil? || value.is_a?(String)
-        return value.collect { |e| e.dig('value') } if value.is_a?(Array) && value[0].is_a?(Hash) && value[0].keys.include?('value')
+        return parse_items(value, name) if value.is_a?(Array) && value[0].is_a?(Hash) && value[0].keys.include?('value')
+        return value.dig('value_usd') if value.is_a?(Hash) && value.keys.include?('value_usd')
         return value.dig('value') if value.is_a?(Hash) && value.keys.include?('value')
 
         value
       end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      def parse_items(items, field_name)
+        return items.collect { |e| e.dig('value') } unless field_name == 'activity_entities'
+
+        # Sepcial case for activity_entities
+        items.each_with_object([]) do |item, objects|
+          card_model = case item['entity_def_id']
+                       when 'person' then ::Crunchbase::Models::Person
+                       when 'organization' then ::Crunchbase::Models::Organization
+                       end
+          # Alias: value is name
+          item['name'] ||= item['value']
+
+          next if card_model.nil?
+
+          new_card_instance = card_model.new
+          objects << dynamic_attributes(new_card_instance, new_card_instance.basis_fields, item)
+        end
+      end
     end
   end
 end

data/lib/crunchbase/utilities/veriables.rb

@@ -142,7 +142,7 @@ module Crunchbase
         'online_and_on_campus' => 'Online and On Campus'
       }.freeze
 
-      SCHOOL_METHODS = {
+      SCHOOL_PROGRAMS = {
         'bootcamp' => 'Bootcamp',
         'community_college' => 'Community College',
         'four_year_university' => 'Four Year University',

data/lib/crunchbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crunchbase
-  VERSION = '0.1.5'
+  VERSION = '0.1.9'
 end

data/lib/crunchbase.rb

@@ -7,17 +7,19 @@ require 'crunchbase/client'
 require 'crunchbase/models'
 require 'crunchbase/entities'
 require 'crunchbase/searches'
+require 'crunchbase/downloads'
 require 'crunchbase/utilities/veriables'
 
 # CB v4
 module Crunchbase
   API_VERSION   = 'v4'
-  BASE_URI      = "https://api.crunchbase.com/api/#{API_VERSION}/"
+  API_DOMAIN    = 'https://api.crunchbase.com'
+  BASE_URI      = "#{API_DOMAIN}/api/#{API_VERSION}/"
 
   # Defined Veriables for the data Category or Types
   #
   # Crunchbase::Utils.constants => [
-  #   :OPERATING_STATUS,
+  #  :OPERATING_STATUS,
   #  :PROGRAM_TYPES,
   #  :REVENUE_RANGES,
   #  :COMPANY_TYPES,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase4
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.9
 platform: ruby
 authors:
 - Encore Shao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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
@@ -136,6 +150,8 @@ files:
 - lib/crunchbase/client.rb
 - lib/crunchbase/config.rb
 - lib/crunchbase/deleted_entities/client.rb
+- lib/crunchbase/downloads.rb
+- lib/crunchbase/downloads/client.rb
 - lib/crunchbase/entities.rb
 - lib/crunchbase/entities/client.rb
 - lib/crunchbase/errors.rb
@@ -165,6 +181,7 @@ files:
 - lib/crunchbase/utilities/autocomplete.rb
 - lib/crunchbase/utilities/cb_model.rb
 - lib/crunchbase/utilities/deleted_entities.rb
+- lib/crunchbase/utilities/downloads.rb
 - lib/crunchbase/utilities/entity_endpoints.rb
 - lib/crunchbase/utilities/request.rb
 - lib/crunchbase/utilities/response.rb
@@ -195,8 +212,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Crunchbase is a ruby wrapper base on Crunchbase V4 API
 test_files: []