crunchbase4 0.1.1 → 0.1.6

data/crunchbase4.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['encore@ekohe.com']
 
   spec.summary       = 'Crunchbase is a ruby wrapper base on Crunchbase V4 API'
-  spec.description   = 'Crunchbase is a ruby wrapper base on Crunchbase V4 API. It provides easy to get the API data by each endpoint. '
+  spec.description   = 'Crunchbase is a ruby wrapper base on Crunchbase V4 API. it provides easy to get the API data by each endpoint. '
   spec.homepage      = 'https://github.com/ekohe/crunchbase4'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
@@ -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

@@ -4,11 +4,40 @@ require 'crunchbase/version'
 
 require 'crunchbase/config'
 require 'crunchbase/client'
+require 'crunchbase/models'
 require 'crunchbase/entities'
 require 'crunchbase/searches'
-require 'crunchbase/models'
+require 'crunchbase/utilities/veriables'
 
+# CB v4
 module Crunchbase
   API_VERSION   = 'v4'
   BASE_URI      = "https://api.crunchbase.com/api/#{API_VERSION}/"
+
+  # Defined Veriables for the data Category or Types
+  #
+  # Crunchbase::Utils.constants => [
+  #  :OPERATING_STATUS,
+  #  :PROGRAM_TYPES,
+  #  :REVENUE_RANGES,
+  #  :COMPANY_TYPES,
+  #  :FACET_IDS,
+  #  :SCHOOL_METHODS,
+  #  :IPO_STATUS,
+  #  :FUNDING_STAGES,
+  #  :CURRENCY_ENUM,
+  #  :DATE_PRECISIONS,
+  #  :LAYOUT_IDS,
+  #  :NUM_EMPLOYEES_ENUM,
+  #  :FUNDING_TYPES,
+  #  :SCHOOL_TYPES,
+  #  :QUERY_OPERATORS,
+  #  :STATUS,
+  #  :STOCK_EXCHANGE_SYMBOLS
+  # ]
+  #
+  #  Crunchbase::Utils::NUM_EMPLOYEES_ENUM
+  class Utils
+    include Utilities::Veriables
+  end
 end

data/lib/crunchbase/autocompletes/client.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative '../utilities/request'
+require_relative '../utilities/cb_model'
+
+module Crunchbase
+  # autocompletes endpoints
+  module Autocompletes
+    # Send request for autocompletes endpoint
+    #
+    # API doc:
+    #   https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.1#/Autocomplete/get_autocompletes
+    class Client
+      include ::Crunchbase::Utilities::Request
+      include ::Crunchbase::Utilities::CbModel
+
+      attr_accessor :total_count, :count, :entities, :conditions, :entity_type
+
+      ROOT_LIST = 'autocompletes'
+      LIMIT = 25
+
+      def initialize(raw_data)
+        @conditions = raw_data
+        @entity_type = 'autocomplete_entity'
+      end
+
+      # Will include all attribute from API document
+      def autocompletes
+        wrapping_autocomplete_entities!(
+          get(
+            ROOT_LIST,
+            autocompletes_parameters
+          )
+        )
+      end
+
+      private
+
+      def wrapping_autocomplete_entities!(response)
+        query_results = search_results(response.dig('entities'))
+
+        self.total_count  = response['count']
+        self.entities     = query_results
+        self.count        = query_results.size
+        self
+      end
+
+      # One item of organization
+      #
+      #  {
+      #   "facet_ids"=>
+      #     ["siftery", "apptopia", "company", "rank", "builtwith", "bombora", "similarweb"],
+      #   "identifier"=>
+      #     {
+      #       "uuid"=>"9fe491b2-b6a1-5c87-0f4d-226dd0cc97a9",
+      #       "value"=>"Ekohe",
+      #       "image_id"=>"v1500646625/zhionn8nlgbkz4lj7ilz.png",
+      #       "permalink"=>"ekohe",
+      #       "entity_def_id"=>"organization"
+      #      },
+      #   "short_description"=>
+      #     "Creating cutting-edge, useful technical solutions to move you forward -- we deliver on the promise of AI."
+      #   }
+      def search_results(entities)
+        entities.each_with_object([]) do |entity, objects|
+          objects << cbobject.parse_response(entity)
+        end
+      end
+
+      def autocompletes_parameters
+        @conditions.merge(limit: @conditions[:limit] || LIMIT)
+      end
+    end
+  end
+end

data/lib/crunchbase/client.rb

@@ -2,11 +2,15 @@
 
 require_relative 'utilities/entity_endpoints'
 require_relative 'utilities/search_endpoints'
+require_relative 'utilities/autocomplete'
+require_relative 'utilities/deleted_entities'
 
 module Crunchbase
   # API Request
   class Client
     include Utilities::EntityEndpoints
     include Utilities::SearchEndpoints
+    include Utilities::Autocomplete
+    include Utilities::DeletedEntities
   end
 end

data/lib/crunchbase/deleted_entities/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative '../utilities/request'
+require_relative '../utilities/cb_model'
+
+module Crunchbase
+  # Retrieve deleted entities
+  module DeletedEntities
+    # Send request for deleted_entities endpoint
+    class Client
+      include ::Crunchbase::Utilities::Request
+      include ::Crunchbase::Utilities::CbModel
+
+      attr_accessor :total_count, :count, :entities, :conditions, :entity_type
+
+      ROOT_LIST = 'deleted_entities'
+      LIMIT = 1000
+
+      def initialize(raw_data)
+        @conditions = raw_data
+        @entity_type = 'deleted_entity'
+      end
+
+      # Will include all attribute from API document
+      def deleted_entities
+        wrapping_deleted_entities!(
+          deleted(
+            ROOT_LIST,
+            deleted_entities_parameters
+          )
+        )
+      end
+
+      private
+
+      def wrapping_deleted_entities!(response)
+        query_results = search_results(response)
+
+        self.total_count  = response.size
+        self.entities     = query_results
+        self.count        = query_results.size
+        self
+      end
+
+      # One item of organization
+      #
+      #  {
+      #   "identifier"=>
+      #     {
+      #       "uuid"=>"9fe491b2-b6a1-5c87-0f4d-226dd0cc97a9",
+      #       "value"=>"Ekohe",
+      #       "image_id"=>"v1500646625/zhionn8nlgbkz4lj7ilz.png",
+      #       "permalink"=>"ekohe",
+      #       "entity_def_id"=>"organization"
+      #      },
+      #   "deleted_at"=>  string($date-time)
+      #   }
+      def search_results(entities)
+        entities.each_with_object([]) do |entity, objects|
+          objects << cbobject.parse_response(entity)
+        end
+      end
+
+      def deleted_entities_parameters
+        @conditions.merge(limit: @conditions[:limit] || LIMIT)
+      end
+    end
+  end
+end

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,32 +21,44 @@ 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
 
       # Only include a part basis fields of endpoint
       def fetch_cards(card_names = [])
-        cbobject.parse_cards_response(entity(
-                                        root_uri,
-                                        field_ids: cbobject.basis_fields.join(','),
-                                        cards: (cbobject.full_cards & card_names).join(',')
-                                      ))
+        cbobject.parse_response(entity(
+                                  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)
-                                ))
+                                  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.rb

@@ -3,7 +3,9 @@
 module Crunchbase
   # Models
   module Models
-    autoload :Entity,                       'crunchbase/models/entity'
+    autoload :Entity,                       'crunchbase/models/concerns/entity'
+    autoload :AutocompleteEntity,           'crunchbase/models/autocomplete_entity'
+    autoload :DeletedEntity,                'crunchbase/models/deleted_entity'
     autoload :Organization,                 'crunchbase/models/organization'
     autoload :Person,                       'crunchbase/models/person'
     autoload :FundingRound,                 'crunchbase/models/funding_round'
@@ -12,5 +14,12 @@ module Crunchbase
     autoload :PressReference,               'crunchbase/models/press_reference'
     autoload :CategoryGroup,                'crunchbase/models/category_group'
     autoload :Category,                     'crunchbase/models/category'
+    autoload :Ipo,                          'crunchbase/models/ipo'
+    autoload :Fund,                         'crunchbase/models/fund'
+    autoload :Ownership,                    'crunchbase/models/ownership'
+    autoload :EventAppearance,              'crunchbase/models/event_appearance'
+    autoload :Principal,                    'crunchbase/models/principal'
+    autoload :Job,                          'crunchbase/models/job'
+    autoload :Address,                      'crunchbase/models/address'
   end
 end

data/lib/crunchbase/models/address.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class Address < Entity
+      RESOURCE_LIST = 'addresses'
+
+      def field_ids
+        %w[
+          created_at
+          entity_def_id
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          name
+          postal_code
+          street_1
+          street_2
+          identifier
+          location_identifiers
+        ]
+      end
+
+      def full_cards
+        %w[
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/autocomplete_entity.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # For AutocompleteEntity
+    class AutocompleteEntity < Entity
+      def field_ids
+        basis_fields
+      end
+
+      def basis_fields
+        %w[
+          identifier
+          facet_ids
+          short_description
+        ]
+      end
+
+      def parse_response(response)
+        dynamic_attributes(self, field_ids, response)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative '../../utilities/response'
+require_relative './mappings'
+
+module Crunchbase
+  # Get the Organization data from API
+  module Models
+    # Root
+    class Entity
+      include ::Crunchbase::Utilities::Response
+      include Mappings
+
+      def fields
+        field_ids.concat(custom_fields).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)
+          card_model = 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
+                           card_data.nil? ? nil : 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
+
+      private
+      def custom_fields
+        []
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Organization data from API
+  module Models
+    # Build card mappings
+    module Mappings
+      def model_mappings
+        {
+          'investments' => Investment,
+          'raised_investments' => Investment,
+          'participated_investments' => Investment,
+          'participated_funds' => Fund,
+          'raised_funds' => Fund,
+          'child_organizations' => Organization,
+          'parent_organization' => Organization,
+          'investors' => Principal,
+          'raised_funding_rounds' => FundingRound,
+          'participated_funding_rounds' => FundingRound,
+          'ipos' => Ipo,
+          'event_appearances' => EventAppearance,
+          'acquiree_acquisitions' => Acquisition,
+          'parent_ownership' => Ownership,
+          'child_ownerships' => Ownership,
+          'jobs' => Job,
+          'founders' => Person,
+          'press_references' => PressReference,
+          'headquarters_address' => Address
+        }
+      end
+
+      def card_num_field(card_id)
+        field_ids & ["num_#{card_id}"]
+      end
+    end
+  end
+end