crunchbase4 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41773106ffa4379736f02219d7c5cc751f2115494b987d81b71757db0ffb2d7c
-  data.tar.gz: 83a8d8f993df099b353f55296f5e86b1d0f75274f300835a6de17fa7a48b5ef5
+  metadata.gz: 84f43d773473d40462a4eead8f4548aaa15eb10b2c5dff849b50d07f579fddf5
+  data.tar.gz: 7f34006abc99d5106cdf7a261adade5e72d8db7be3d68a1cbd3bccdfb8e1d10b
 SHA512:
-  metadata.gz: bf41a960cf7a3d2b0e1b36173d9f64c3de0e3753a8a4ce13a9061d6862390489b007aa9c94339dc7cda178b0f86928f47e1b18a5780147c6dbb6c88ca07fa91f
-  data.tar.gz: 2ec1c99e9813b9da04af5dea643caf660c51e9b95ca703af0a8f09c136ea4d48d572888f6aca599f43d45d38853681be5e08971b43440814dd9f3f4bfc7a2cf1
+  metadata.gz: ab8418cc8cb8739460bb1335092dee1f9110e9453f4ab61bca6430ad0250251db887e5cf95637fb0d1f319030a4b16ad0e188c3c925b9c63ea1aa2fd257da25b
+  data.tar.gz: 67c78499a471c58315b1ff8d6c4abd5fe262dda55cfd2d67edf74be77d701a4e777db43cb1b6d38cb7d4cd1e0f6642b93b52f5608ee5df741830103378d5ff3d

data/CHANGELOG.md

@@ -1,15 +1,32 @@
 # Change Log
 
+## [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 organzations
+      - Before:  (`client.deleted_organzations`)
+      - 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`)
+      - After :  (`client.autocomplete('ekohe', collection_ids: 'organizations', limit: 3)`)
+
 ## [0.1.4] - 2020-06-12
 
 ### Added
-- Implemented a API to get the fund data of Entity (`client.fund(entity_id)`)
-- Implemented a API to get the ownership data of Entity (`client.ownership(entity_id)`)
-- Implemented a API to get the founders data of Entity (`client.founders(entity_id)`)
-- Implemented a API to get the event_appearances data of Entity (`client.event_appearances(entity_id)`)
-- Implemented a API to get the investors data of Entity (`client.investors(entity_id)`)
-- Implemented a API to get the jobs data of Entity (`client.jobs(entity_id)`)
-- Implemented a API to get the headquarters_address data of Entity (`client.headquarters_address(entity_id)`)
+- 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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crunchbase4 (0.1.4)
+    crunchbase4 (0.1.5)
       faraday
       faraday_curl
       faraday_middleware

data/README.md

@@ -56,13 +56,21 @@ pry(main)> client = Crunchbase::Client.new
 - [Deleted Entities](https://github.com/ekohe/crunchbase4#deleted-entities)
 
 ```ruby
-<!-- Entity -->
-response = client.organization('ekohe')
-response = client.organization('ekohe', 'ipos')
+<!-- Entity 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)
+
 response = client.person('mark-zuckerberg')
-response = client.person('mark-zuckerberg', 'participated_investments')
+response = client.person('mark-zuckerberg', card_id: 'participated_investments')
 response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247', 'investments')
+response = client.funding_round('371c20af8aa94bcba8da0694d138f247', 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')
@@ -83,14 +91,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
@@ -489,7 +500,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,
@@ -521,7 +532,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,
@@ -553,7 +564,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,
@@ -587,7 +598,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,
@@ -611,8 +622,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/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.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

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

@@ -28,6 +28,10 @@ module Crunchbase
           'headquarters_address' => Address
         }
       end
+
+      def card_num_field(card_id)
+        field_ids & ["num_#{card_id}"]
+      end
     end
   end
 end

data/lib/crunchbase/utilities/autocomplete.rb

@@ -33,33 +33,18 @@ module Crunchbase
       #     query: keyword,
       #     collection_ids: 'organizations'
       #  }
-      def autocomplete_organizations(keyword)
-        autocompletes(wrapper_autocompletes_data(keyword, 'organizations'))
-      end
-
-      def autocomplete_people(keyword)
-        autocompletes(wrapper_autocompletes_data(keyword, 'people'))
-      end
-
-      def autocomplete_funding_rounds(keyword)
-        autocompletes(wrapper_autocompletes_data(keyword, 'funding_rounds'))
-      end
-
-      def autocomplete_press_references(keyword)
-        autocompletes(wrapper_autocompletes_data(keyword, 'press_references'))
+      def autocomplete(keyword, **args)
+        crunchbase_autocompletes(wrapper_autocompletes_data(keyword, args))
       end
 
       private
 
-      def autocompletes(raw_data)
+      def crunchbase_autocompletes(raw_data)
         Crunchbase::Autocompletes::Client.new(raw_data).autocompletes
       end
 
-      def wrapper_autocompletes_data(keyword, collection_ids)
-        {
-          query: keyword,
-          collection_ids: collection_ids
-        }
+      def wrapper_autocompletes_data(keyword, **args)
+        { query: keyword }.merge(args)
       end
     end
   end

data/lib/crunchbase/utilities/deleted_entities.rb

@@ -33,30 +33,14 @@ module Crunchbase
       #   deleted_at_order: string
       #     Direction of sorting by deleted_at property
       #       Available values : asc, desc
-      def deleted_organizations(args = {})
-        deleted_entities(wrapper_deleted_entities_data(args, 'organizations'))
-      end
-
-      def deleted_people(args = {})
-        deleted_entities(wrapper_deleted_entities_data(args, 'people'))
-      end
-
-      def deleted_funding_rounds(args = {})
-        deleted_entities(wrapper_deleted_entities_data(args, 'funding_rounds'))
-      end
-
-      def deleted_press_references(args = {})
-        deleted_entities(wrapper_deleted_entities_data(args, 'press_references'))
+      def deleted_entities(**args)
+        crunchbase_deleted_entities(args)
       end
 
       private
 
-      def deleted_entities(raw_data)
-        Crunchbase::DeletedEntities::Client.new(raw_data).deleted_entities
-      end
-
-      def wrapper_deleted_entities_data(args, collection_ids = nil)
-        args.merge!(collection_ids: collection_ids)
+      def crunchbase_deleted_entities(args)
+        Crunchbase::DeletedEntities::Client.new(args).deleted_entities
       end
     end
   end

data/lib/crunchbase/utilities/entity_endpoints.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../errors'
+
 module Crunchbase
   # Utilities
   module Utilities
@@ -15,8 +17,8 @@ module Crunchbase
       #   limit:      Number of rows to return. Default is 100, min is 1, max is 100.
 
       # Lookup an Organization or single card
-      def organization(entity_id, card_id: nil)
-        lookup_for('organization', entity_id, card_id)
+      def organization(entity_id, **card_args)
+        lookup_for('organization', entity_id, card_args)
       end
 
       # Lookup Organization's all cards
@@ -25,8 +27,8 @@ module Crunchbase
       end
 
       # Lookup a Person or single card
-      def person(entity_id, card_id: nil)
-        lookup_for('person', entity_id, card_id)
+      def person(entity_id, **card_args)
+        lookup_for('person', entity_id, card_args)
       end
 
       # Lookup Person's all cards
@@ -35,8 +37,8 @@ module Crunchbase
       end
 
       # Lookup a Funding Round or single card
-      def funding_round(entity_id, card_id: nil)
-        lookup_for('funding_round', entity_id, card_id)
+      def funding_round(entity_id, **card_args)
+        lookup_for('funding_round', entity_id, card_args)
       end
 
       # Lookup Funding Round's all cards
@@ -45,8 +47,8 @@ module Crunchbase
       end
 
       # Lookup an Acquisition or Single card
-      def acquisition(entity_id, card_id: nil)
-        lookup_for('acquisition', entity_id, card_id)
+      def acquisition(entity_id, **card_args)
+        lookup_for('acquisition', entity_id, card_args)
       end
 
       # Lookup Acquisition's all card
@@ -55,8 +57,8 @@ module Crunchbase
       end
 
       # Lookup an Investment or Single card
-      def investment(entity_id, card_id: nil)
-        lookup_for('investment', entity_id, card_id)
+      def investment(entity_id, **card_args)
+        lookup_for('investment', entity_id, card_args)
       end
 
       # Lookup Investment's all card
@@ -65,8 +67,8 @@ module Crunchbase
       end
 
       # Lookup an PressReference or Single card
-      def press_reference(entity_id, card_id: nil)
-        lookup_for('press_reference', entity_id, card_id)
+      def press_reference(entity_id, **card_args)
+        lookup_for('press_reference', entity_id, card_args)
       end
 
       # Lookup PressReference's all card
@@ -75,8 +77,8 @@ module Crunchbase
       end
 
       # Lookup an Ipo or Single card
-      def ipo(entity_id, card_id: nil)
-        lookup_for('ipo', entity_id, card_id)
+      def ipo(entity_id, **card_args)
+        lookup_for('ipo', entity_id, card_args)
       end
 
       # Lookup Ipo's all card
@@ -85,8 +87,8 @@ module Crunchbase
       end
 
       # Lookup an fund or Single card
-      def fund(entity_id, card_id: nil)
-        lookup_for('fund', entity_id, card_id)
+      def fund(entity_id, **card_args)
+        lookup_for('fund', entity_id, card_args)
       end
 
       # Lookup fund's all card
@@ -95,8 +97,8 @@ module Crunchbase
       end
 
       # Lookup an fund or Single card
-      def ownership(entity_id, card_id: nil)
-        lookup_for('ownership', entity_id, card_id)
+      def ownership(entity_id, **card_args)
+        lookup_for('ownership', entity_id, card_args)
       end
 
       # Lookup fund's all card
@@ -110,11 +112,13 @@ module Crunchbase
         Crunchbase::Entities::Client.new(entity_id, entity_type)
       end
 
-      def lookup_for(entity_type, entity_id, card_id)
+      def lookup_for(entity_type, entity_id, **card_args)
         kobject = entities(entity_type, entity_id)
+
+        card_id = card_args&.delete(:card_id)
         return kobject.fetch if card_id.nil?
 
-        kobject.cards(card_id)
+        kobject.cards(card_id, card_args)
       end
     end
   end

data/lib/crunchbase/utilities/request.rb

@@ -9,7 +9,11 @@ require_relative '../errors'
 module Crunchbase
   # Utilities
   module Utilities
-    # API Request
+    # Key Reminder
+    #
+    #   entity_id must be provided in the request
+    #   entity_id can be the uuid or the permalink of the entity
+    #   you can pass your API key in the request's header if you do not want to pass the API key in the URL
     module Request
       module_function
 
@@ -56,7 +60,7 @@ module Crunchbase
 
         return response.body if response.status == 200
 
-        raise Error, response.body['error']
+        raise Error, response.status == 400 ? response.body[0]['message'] : response.body['error']
       end
 
       def debug_mode?

data/lib/crunchbase/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase4
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Encore Shao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday