crunchbase4 0.1.3 → 0.1.8

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
@@ -84,17 +86,39 @@ module Crunchbase
         entities('ipo', entity_id).fetch_cards(cards)
       end
 
+      # Lookup an fund or Single card
+      def fund(entity_id, **card_args)
+        lookup_for('fund', entity_id, card_args)
+      end
+
+      # Lookup fund's all card
+      def fund_cards(entity_id, cards: [])
+        entities('fund', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup an fund or Single card
+      def ownership(entity_id, **card_args)
+        lookup_for('ownership', entity_id, card_args)
+      end
+
+      # Lookup fund's all card
+      def ownership_cards(entity_id, cards: [])
+        entities('ownership', entity_id).fetch_cards(cards)
+      end
+
       private
 
       def entities(entity_type, entity_id)
         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/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.3'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase4
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.8
 platform: ruby
 authors:
 - Encore Shao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -141,17 +141,24 @@ files:
 - lib/crunchbase/errors.rb
 - lib/crunchbase/models.rb
 - lib/crunchbase/models/acquisition.rb
+- lib/crunchbase/models/address.rb
 - lib/crunchbase/models/autocomplete_entity.rb
 - lib/crunchbase/models/category.rb
 - lib/crunchbase/models/category_group.rb
+- lib/crunchbase/models/concerns/entity.rb
+- lib/crunchbase/models/concerns/mappings.rb
 - lib/crunchbase/models/deleted_entity.rb
-- lib/crunchbase/models/entity.rb
+- lib/crunchbase/models/event_appearance.rb
+- lib/crunchbase/models/fund.rb
 - lib/crunchbase/models/funding_round.rb
 - lib/crunchbase/models/investment.rb
 - lib/crunchbase/models/ipo.rb
+- lib/crunchbase/models/job.rb
 - lib/crunchbase/models/organization.rb
+- lib/crunchbase/models/ownership.rb
 - lib/crunchbase/models/person.rb
 - lib/crunchbase/models/press_reference.rb
+- lib/crunchbase/models/principal.rb
 - lib/crunchbase/searches.rb
 - lib/crunchbase/searches/client.rb
 - lib/crunchbase/utilities.rb
@@ -172,7 +179,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/ekohe/crunchbase4
   source_code_uri: https://github.com/ekohe/crunchbase4
-  changelog_uri: https://github.com/ekohe/crunchbase4/CHANGELOG.md
+  changelog_uri: https://github.com/ekohe/crunchbase4/blob/master/CHANGELOG.md
 post_install_message: Thanks for installing!
 rdoc_options: []
 require_paths:
@@ -188,8 +195,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.2
+signing_key:
 specification_version: 4
 summary: Crunchbase is a ruby wrapper base on Crunchbase V4 API
 test_files: []

data/lib/crunchbase/models/entity.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../utilities/response'
-
-module Crunchbase
-  # Get the Organization data from API
-  module Models
-    # Root
-    class Entity
-      include ::Crunchbase::Utilities::Response
-
-      def fields
-        field_ids.map(&:to_sym)
-      end
-
-      def parse_response(response, request_field_ids = [], cards = [])
-        extract_fields = (request_field_ids.empty? ? field_ids : request_field_ids)
-
-        dynamic_attributes(self, extract_fields, response.dig('properties'))
-        setup_relationships(self, cards, response.dig('cards'))
-        self
-      end
-
-      def setup_relationships(object, request_card_ids, response_cards)
-        request_card_ids.each do |card_id|
-          card_data = response_cards.dig(card_id)
-          next if card_data.nil? || card_data.empty?
-
-          card_model = card_model_mappings[card_id]
-          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)
-                           end
-                         else
-                           dynamic_attributes(card_model.new, extract_fields, data)
-                         end
-
-          dynamic_define_method(object, card_id, card_objects)
-        end
-      end
-
-      def as_json
-        fields.each_with_object({}) { |item, hash| hash[item] = send(item) }
-      end
-
-      def card_model_mappings
-        {
-          'investments' => Crunchbase::Models::Investment,
-          'raised_investments' => Crunchbase::Models::Investment,
-          # 'participated_funds' => Crunchbase::Models::Fund,
-          'child_organizations' => Crunchbase::Models::Organization,
-          'participated_investments' => Crunchbase::Models::Investment,
-          # 'investors' => Crunchbase::Models::Investor,
-          'parent_organization' => Crunchbase::Models::Organization,
-          'raised_funding_rounds' => Crunchbase::Models::FundingRound,
-          'ipos' => Crunchbase::Models::Ipo,
-          # 'event_appearances' => Crunchbase::Models::EventAppearance,
-          # 'raised_funds' => Crunchbase::Models::Fund,
-          'acquiree_acquisitions' => Crunchbase::Models::Acquisition,
-          # 'parent_ownership' => Crunchbase::Models::Ownership,
-          # 'jobs' => Crunchbase::Models::Job,
-          # 'founders' => Crunchbase::Models::Founder,
-          # 'child_ownerships' => Crunchbase::Models::Ownership,
-          'participated_funding_rounds' => Crunchbase::Models::FundingRound,
-          'press_references' => Crunchbase::Models::PressReference
-          # 'headquarters_address' => Crunchbase::Models::Address,
-        }
-      end
-    end
-  end
-end