crunchbase4 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3b4fc39257c331e78bdf3f05dd4e08c96c67b34c8e0627c2c7bc5a583f5a7f6
-  data.tar.gz: 22f753ee2a2b785247c8311fd126ef826853028c542bbae010e55a391aa59e6e
+  metadata.gz: d55577caf7591f6f9da599815b133401620f51137d303e9f1d56ca1a37554a30
+  data.tar.gz: e0b0a754d0060dd9d3f566ce3cea3f6120c3bec2c3fd9dd490d6d6c1dfdaa04c
 SHA512:
-  metadata.gz: 13c65190a96019e452efe17a6f0173c4cc3f1cbf28ca067fc56da2c394377f5b3f48176d3c34383e242bfa25ead36a9a70156ba0c243e23381ab7c39ba9bbcfd
-  data.tar.gz: c13e836e817f2509dac847db8c8f733eb680d0eb69e81961cab23288d9bf3190479481bd5fe9b67a1402d0f164195ba3097601a9c3a7bade0bfb78561380e2e3
+  metadata.gz: 740e35d9fabbf05e930aa6a3a663143b0dee43d77ccb29b2845d79836ee2891a5b9eb4a360ba03dd2087afaea6525cafefe8beb0ed299d17d375be0eddab285f
+  data.tar.gz: ca15245080f46ca75779e1b694842a206a1ece5107b31b9a937a5e3ae049ff0247cf74b5e390c13290b9360ab1a4678832a7f36cb3dbe07ed1cb31d67098c7c2

data/.gitignore

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

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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

data/Gemfile.lock

@@ -1,29 +1,54 @@
 PATH
   remote: .
   specs:
-    crunchbase4 (0.1.7)
+    crunchbase4 (0.2.0)
       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.2.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

@@ -26,13 +26,18 @@ Or install it yourself as:
 #### Configure your certificate for API
 
 ```ruby
-require 'crunchbase4'
+require 'crunchbase'
 
-CB_CONFIG = YAML.load(File.read('crunchbase.yml'))
-Crunchbase.config.user_key = CB_CONFIG['user_key']
-Crunchbase.config.user_key = false # If you want to know the request information, can set the debug = true
+config = YAML.load(File.read('spec/crunchbase.yml'))
+Crunchbase.config.user_key = config['user_key']
+Crunchbase.config.debug = config['debug'] || false # If you want to know the request information, can set the debug = true
 ```
 
+#### If you want to use it in Rails Application, simple way to create a file `crunchbase.rb` in `config/initializers`
+
+- and put the above info(https://github.com/ekohe/crunchbase4#configure-your-certificate-for-api) into the new file
+
+
 ## Usage
 
 #### Class: `Client` for API
@@ -711,6 +716,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

@@ -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)

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/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/request.rb

@@ -44,9 +44,11 @@ module Crunchbase
           faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
         end.post(uri, args)
 
-        return response.body if response.status == 200
+        resp_body = response.body
+        resp_status = response.status
+        return resp_body if resp_status == 200
 
-        raise Error, response.body[0]['message']
+        raise Error, resp_body.is_a?(Array) ? resp_body[0]['message'] : resp_body['error']
       end
 
       private
@@ -58,9 +60,11 @@ module Crunchbase
           faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
         end.get(uri, *args)
 
-        return response.body if response.status == 200
+        resp_body = response.body
+        resp_status = response.status
+        return resp_body if resp_status == 200
 
-        raise Error, response.status == 400 ? response.body[0]['message'] : response.body['error']
+        raise Error, resp_body.is_a?(Array) ? resp_body[0]['message'] : resp_body['error']
       end
 
       def debug_mode?

data/lib/crunchbase/utilities/response.rb

@@ -52,15 +52,18 @@ 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 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'

data/lib/crunchbase/version.rb

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

data/lib/crunchbase.rb

@@ -7,12 +7,14 @@ 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
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase4
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Encore Shao
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2022-07-10 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