crunchbase4 0.1.3 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 305bc09f8a83e2c4413f2e1dd7081b371b118e6e40727c9770e9c816f50d7e5b
-  data.tar.gz: e8c2c700770b5e08be5a69e613c6381877b9d1a5b551fe96114185eae2b8ce26
+  metadata.gz: 21f1d6c0bae981ebb5f54925d0db9a577c39e0e620bad32de9ba471cf4249545
+  data.tar.gz: fff8a1bf44fd50e44eda6b099c9eaf1cf091ab1e259dcaee2bbd4c1c86779d0d
 SHA512:
-  metadata.gz: f6423c5de66af723a227aac874dafb6815921cd7e3ee4efe1015adaf551b46ff55eac7335b496caae71909e0507e210139579507f516d2f2090fdd8cc4d0fb1d
-  data.tar.gz: 7601a5f4c815c59c12c855694d7a7e497456eed498c1a1c15d396fec9197bf7c6c3fc0d276d3dbcf7d8acb2a2f0cf85cb63874c0c68cdedc8c49b6b07d0e1c5b
+  metadata.gz: b77c39ab92e4610365f65cded56e13100ee58deaf76247531c5983e1fdb5c22d744c6f3d71bb6745a3effd83baac722079e87da6ce367f5a9dd5d6c712dcd3bb
+  data.tar.gz: 8d355c0fc87a2b70db8af8a02b0473f909a45573a2b3495a58c21a799465f92369892432db9c5e03dd2bb47a77b4f38b9955e144b1a50ee01659ee9ebee667eb

data/.gitignore

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

data/CHANGELOG.md

@@ -1,6 +1,44 @@
 # Change Log
 
-All notable changes to this project will be documented in this file.
+## [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
+- Add more query condition support for card query (limit, order, before_id, after_id)
+    * Before
+      - Get organzation's fund: (`client.organization(entity_id, 'fund')`)
+    * 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 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 organizations
+      - Before:  (`client.autocomplete_organizations`)
+      - After :  (`client.autocomplete('ekohe', collection_ids: 'organizations', limit: 3)`)
+
+## [0.1.4] - 2020-06-12
+
+### Added
+- Implemented APIs to get the cards data of Entity
+  - fund: (`client.organization(entity_id, 'fund')`)
+  - ownership: (`client.organization(entity_id, 'ownership')`)
+  - founders: (`client.organization(entity_id, 'founders')`)
+  - investors: (`client.organization(entity_id, 'investors')`)
+  - jobs: (`client.organization(entity_id, 'jobs')`)
+  - headquarters_address: (`client.organization(entity_id, 'headquarters_address')`)
 
 ## [0.1.3] - 2020-06-09
 
@@ -12,11 +50,11 @@ All notable changes to this project will be documented in this file.
 
 ### 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
 
@@ -24,7 +62,7 @@ All notable changes to this project will be documented in this file.
 
 ### 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crunchbase4 (0.1.3)
+    crunchbase4 (0.1.7)
       faraday
       faraday_curl
       faraday_middleware

data/README.md

@@ -3,7 +3,7 @@
 Crunchbase is a ruby wrapper based on Crunchbase V4 API. it provides easy to get the API data by each endpoint. [CB v4 DOC](https://app.swaggerhub.com/apis/Crunchbase/crunchbase-enterprise_api/1.0.1)
 
 [![Gem Version](https://badge.fury.io/rb/crunchbase4.svg)](https://badge.fury.io/rb/crunchbase4)
-[![Build Status](https://travis-ci.org/encoreshao/crunchbase4.svg?branch=master)](https://travis-ci.org/encoreshao/crunchbase4)
+[![Build Status](https://travis-ci.org/ekohe/crunchbase4.svg?branch=master)](https://travis-ci.org/ekohe/crunchbase4)
 
 ## Installation
 
@@ -30,6 +30,7 @@ require 'crunchbase4'
 
 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
 ```
 
 ## Usage
@@ -43,22 +44,50 @@ pry(main)> client = Crunchbase::Client.new
 #### API request for endpoint we completed
 
 - [Entity](https://github.com/ekohe/crunchbase4#entity)
-  - organizations
-  - people
-  - funding_rounds
+  - Organization
+    - fields
+    - cards: [raised_investments, participated_funds, child_organizations, participated_investments, investors, parent_organization, raised_funding_rounds, ipos, event_appearances, raised_funds, acquiree_acquisitions, acquirer_acquisitions, parent_ownership, jobs, founders, child_ownerships, participated_funding_rounds, press_references, headquarters_address]
+  - Person
+    - fields
+  - FundingRound
+    - fields
 - [Searches](https://github.com/ekohe/crunchbase4#search)
 - [Autocompletes](https://github.com/ekohe/crunchbase4#autocompletes)
 - [Deleted Entities](https://github.com/ekohe/crunchbase4#deleted-entities)
 
 ```ruby
-<!-- Entity -->
-response = client.organization('ekohe')
-response = client.organization('ekohe', 'ipos')
+<!-- Examples of organization and single card -->
+response                = client.organization('ekohe')
+ipos                    = client.organization('ekohe', card_id: 'ipos')
+fund                    = client.organization('ekohe', card_id: 'fund')
+ownership               = client.organization('ekohe', card_id: 'ownership')
+founders                = client.organization('ekohe', card_id: 'founders')
+investors               = client.organization('ekohe', card_id: 'investors')
+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', 'participated_investments')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247', 'investments')
+response = client.person('mark-zuckerberg', card_id: 'participated_investments')
+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 -->
+
+response.as_json
 
 <!-- Search -->
 client.search_organizations(query_data)
@@ -72,14 +101,17 @@ client.recent_updates({
                       })
 
 <!-- Autocompletes -->
-response = client.autocomplete_organizations('ekohe')
-response = client.autocomplete_people('encore')
-response = client.autocomplete_funding_rounds('facebook')
+response = client.autocomplete('ekohe')
+response = client.autocomplete('ekohe', collection_ids: 'organizations')
+response = client.autocomplete('ekohe', collection_ids: 'organizations', limit: 3)
+response = client.autocomplete('encore', collection_ids: 'people')
+response = client.autocomplete('facebook', collection_ids: 'funding_rounds')
+response = client.autocomplete('facebook', collection_ids: 'press_references')
 
 <!-- Deleted Entities -->
-response = client.deledeted_organizations
-response = client.deledeted_people
-response = client.deledeted_funding_rounds
+response = client.deledeted_entities(collection_ids: 'organizations')
+response = client.deledeted_entities(collection_ids: 'people')
+response = client.deledeted_entities(collection_ids: 'funding_rounds')
 ```
 
 #### Module: Utils
@@ -155,7 +187,6 @@ pry(main)> response.permalink
 ##### Get the funding round data
 
 ```ruby
-=> #<Crunchbase::Client:0x00007f8806824c28>
 pry(main)> response = client.funding_round('371c20af-8aa9-4bcb-a8da-0694d138f247')
 => #<Crunchbase::Models::FundingRound:0x00007f8806b55ca8
  @announced_on="2013-06-30",
@@ -175,6 +206,30 @@ pry(main)> response.name
 pry(main)> response.uuid
 => "371c20af-8aa9-4bcb-a8da-0694d138f247"
 ```
+##### Get the fund data
+
+```ruby
+pry(main)> response = client.fund('aeaac12b-df56-7039-40f9-f1992f88e20e')
+=> #<Crunchbase::Models::Fund:0x00007ffa6a5a4080
+ @announced_on="2017-04-03",
+ @created_at="2017-04-04T04:40:49Z",
+ @entity_def_id="fund",
+ @image_id="v1491280776/azwvvy68ap2o29ffcnn7.png",
+ @investor_identifiers=["Betaworks", "Craig Newmark Philanthropies", "Democracy Fund", "Facebook", "Ford Foundation", "Knight Foundation", "Mozilla", "Tow Foundation"],
+ @money_raised=14000000,
+ @name="The News Integrity Initiative Fund I",
+ @num_investors=8,
+ @owner_identifier="The News Integrity Initiative",
+ @permalink="the-news-integrity-initiative-raised-the-news-integrity-initiative-fund-i--aeaac12b",
+ @short_description="The News Integrity Initiative raises new  The News Integrity Initiative Fund I on 2017-04-03",
+ @started_on=nil,
+ @updated_at="2018-02-12T22:18:54Z",
+ @uuid="aeaac12b-df56-7039-40f9-f1992f88e20e">
+pry(main)> response.name
+=> "The News Integrity Initiative Fund I"
+pry(main)> response.uuid
+=> "aeaac12b-df56-7039-40f9-f1992f88e20e"
+```
 
 ##### Get the acquisition data
 
@@ -197,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",
@@ -236,6 +366,27 @@ pry(main)> response = client.investment('1368da0c-07b0-46ef-9a86-b518367e60d6')
  @uuid="1368da0c-07b0-46ef-9a86-b518367e60d6">
 ```
 
+##### Get the ownership data
+
+```ruby
+pry(main)> response = client.ownership('4506d9ce-85d3-4a8f-89cd-07a225359d55')
+=> #<Crunchbase::Models::Ownership:0x00007fbf2fdb78b0
+ @created_at="2015-03-04T20:04:23Z",
+ @entity_def_id="ownership",
+ @identifier=["4506d9ce-85d3-4a8f-89cd-07a225359d55", "Facebook owns Instagram", "facebook-owns-instagram--4506d9ce"],
+ @name="Facebook owns Instagram",
+ @ownee_identifier="Instagram",
+ @owner_identifier="Facebook",
+ @ownership_type="subsidiary",
+ @permalink="facebook-owns-instagram--4506d9ce",
+ @updated_at="2018-02-13T01:18:10Z",
+ @uuid="4506d9ce-85d3-4a8f-89cd-07a225359d55">
+pry(main)> response.name
+=> "Facebook owns Instagram"
+pry(main)> response.uuid
+=> "4506d9ce-85d3-4a8f-89cd-07a225359d55"
+```
+
 ### Search
 
 * Search query parameters for each endpoint
@@ -434,7 +585,7 @@ Search by keyword has been supported in "Organization", "People" and "Fund Round
 * Search in an organization by keyword
 
 ```ruby
-pry(main)> response = client.autocomplete_organizations('ekohe')
+pry(main)> response = client.autocomplete('ekohe', collection_ids: 'organizations')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb34ce1e8
  @conditions={:query=>"ekohe", :collection_ids=>"organizations"},
  @count=25,
@@ -466,7 +617,7 @@ pry(main)> response.total_count
 * Search in an people by keyword
 
 ```ruby
-pry(main)> response = client.autocomplete_people('maxime')
+pry(main)> response = client.autocomplete('maxime', collection_ids: 'people')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb474f9c0
  @conditions={:query=>"maxime", :collection_ids=>"people"},
  @count=25,
@@ -498,7 +649,7 @@ pry(main)> response.total_count
 * Search in an funding rounds by keyword
 
 ```ruby
-pry(main)> response = client.autocomplete_funding_rounds('facebook')
+pry(main)> response = client.autocomplete('facebook', collection_ids: 'funding_rounds')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb4dd66b8
  @conditions={:query=>"facebook", :collection_ids=>"funding_rounds"},
  @count=25,
@@ -532,7 +683,7 @@ pry(main)> response.total_count
 * Get deleted entities by collection_ids
 
 ```ruby
-pry(main)> response = client.deleted_organizations
+pry(main)> response = client.deleted_entities
 => #<Crunchbase::DeletedEntities::Client:0x00007fa9196b6498
  @conditions={:collection_ids=>"organizations"},
  @count=1000,
@@ -556,8 +707,8 @@ pry(main)> response.count
 pry(main)> response.total_count
 
 # Get deleted people and funding rounds
-pry(main)> response = client.deleted_people
-pry(main)> response = client.deleted_funding_rounds
+pry(main)> response = client.deleted_entities(collection_ids: 'people')
+pry(main)> response = client.deleted_entities(collection_ids: 'funding_rounds')
 ```
 
 ## Development

data/crunchbase4.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/ekohe/crunchbase4'
-  spec.metadata['changelog_uri'] = 'https://github.com/ekohe/crunchbase4/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/ekohe/crunchbase4/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/crunchbase.rb

@@ -17,7 +17,7 @@ module Crunchbase
   # Defined Veriables for the data Category or Types
   #
   # Crunchbase::Utils.constants => [
-  #   :OPERATING_STATUS,
+  #  :OPERATING_STATUS,
   #  :PROGRAM_TYPES,
   #  :REVENUE_RANGES,
   #  :COMPANY_TYPES,

data/lib/crunchbase/entities/client.rb

@@ -6,7 +6,7 @@ require_relative '../utilities/cb_model'
 module Crunchbase
   # Whole entities endpoints
   module Entities
-    # Send request for entities endpoints
+    # using Crunchbase's Entity Lookup API endpoints
     class Client
       include ::Crunchbase::Utilities::Request
       include ::Crunchbase::Utilities::CbModel
@@ -21,7 +21,7 @@ module Crunchbase
       # Will include all attribute from API document
       def fetch
         cbobject.parse_response(entity(
-                                  root_uri,
+                                  entity_request_uri,
                                   field_ids: cbobject.field_ids.join(',')
                                 ))
       end
@@ -29,28 +29,36 @@ module Crunchbase
       # Only include a part basis fields of endpoint
       def fetch_cards(card_names = [])
         cbobject.parse_response(entity(
-                                  root_uri,
+                                  entity_request_uri,
                                   field_ids: cbobject.basis_fields.join(','),
                                   cards: (cbobject.full_cards & card_names).join(',')
                                 ), cbobject.basis_fields, card_names)
       end
 
-      def cards(card_id)
+      # Auto combine the card num field to request field_ids
+      #
+      #   Example: if card_id is investors, will auto add num_investors
+      def cards(card_id, **args)
         raise Crunchbase::Error, 'Invalid card_id' unless cbobject.full_cards.include?(card_id)
 
+        field_ids = cbobject.basis_fields.concat(cbobject.card_num_field(card_id))
+
+        request_args = args.merge(
+          field_ids: field_ids.join(','),
+          card_field_ids: cbobject.model_mappings[card_id].new.field_ids.join(',')
+        )
         cbobject.parse_response(entity(
-                                  root_uri(name: __method__, id: card_id),
-                                  field_ids: cbobject.basis_fields.join(','),
-                                  card_field_ids: cbobject.card_model_mappings[card_id].new.field_ids.join(',')
-                                ), cbobject.basis_fields, [card_id])
+                                  entity_request_uri(name: __method__, card_id: card_id),
+                                  request_args
+                                ), field_ids, [card_id])
       end
 
       private
 
-      def root_uri(args = {})
+      def entity_request_uri(**args)
         [
           ROOT_LIST, kclass_name::RESOURCE_LIST,
-          @entity_id, args[:name], args[:id]
+          @entity_id, args[:name], args[:card_id]
         ].compact.join('/')
       end
     end