crunchbase4 0.1.0 → 0.1.5

data/crunchbase4.gemspec

@@ -6,11 +6,11 @@ Gem::Specification.new do |spec|
   spec.name          = 'crunchbase4'
   spec.version       = Crunchbase::VERSION
   spec.authors       = ['Encore Shao']
-  spec.email         = ['encore.shao@gmail.com']
+  spec.email         = ['encore@ekohe.com']
 
-  spec.summary       = 'Ruby Library for Crunchbase API Version 4.0'
-  spec.description   = 'A Ruby wrapper for Crunchbase API version 4.0, crunchbase build new API interface by GraphQL'
-  spec.homepage      = 'https://github.com/encoreshao/crunchbase4'
+  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.homepage      = 'https://github.com/ekohe/crunchbase4'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
   spec.post_install_message = 'Thanks for installing!'
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/encoreshao/crunchbase4'
-  spec.metadata['changelog_uri'] = 'https://github.com/encoreshao/crunchbase4/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/ekohe/crunchbase4'
+  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.
@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday_curl'
   spec.add_dependency 'faraday_middleware'
 
   # VCR for testing APIs

data/lib/crunchbase.rb

@@ -3,14 +3,41 @@
 require 'crunchbase/version'
 
 require 'crunchbase/config'
-require 'crunchbase/utilities'
 require 'crunchbase/client'
+require 'crunchbase/models'
 require 'crunchbase/entities'
 require 'crunchbase/searches'
-require 'crunchbase/models'
-require 'crunchbase/errors'
+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

@@ -1,47 +1,16 @@
 # frozen_string_literal: true
 
+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
-    # API Parameters
-    #
-    #   entity_id:  UUID or permalink of desired entity
-    #   card_id:    A card to include on the resulting entity
-    #   order:      Field name with order direction (asc/desc)
-    #   limit:      Number of rows to return. Default is 100, min is 1, max is 100.
-    def organization(entity_id, card_id: nil)
-      kobject = entities('Organization', entity_id)
-      return kobject.fetch if card_id.nil?
-
-      kobject.cards(card_id)
-    end
-
-    # Fetching all cards of organization
-    def organization_cards(entity_id, cards: [])
-      entities('Organization', entity_id).fetch_cards(cards)
-    end
-
-    def person(entity_id, card_id: nil)
-      kobject = entities('Person', entity_id)
-      return kobject.fetch if card_id.nil?
-
-      kobject.cards(card_id)
-    end
-
-    # Fetching all cards of people
-    def person_cards(entity_id)
-      entities('Person', entity_id).fetch_cards
-    end
-
-    def searches(keyword, _scope: nil)
-      Crunchbase::Searches::Organization.new('name', keyword)
-    end
-
-    private
-
-    def entities(kclass_name, entity_id)
-      model_name = Kernel.const_get("Crunchbase::Models::#{kclass_name}")
-      Crunchbase::Entities::Client.new(entity_id, model_name)
-    end
+    include Utilities::EntityEndpoints
+    include Utilities::SearchEndpoints
+    include Utilities::Autocomplete
+    include Utilities::DeletedEntities
   end
 end

data/lib/crunchbase/config.rb

@@ -7,7 +7,7 @@ module Crunchbase
   # Config
   class Config
     include Singleton
-    attr_accessor :user_key
+    attr_accessor :user_key, :debug
   end
 
   def self.config

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

@@ -1,50 +1,64 @@
 # frozen_string_literal: true
 
+require_relative '../utilities/request'
+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
-
-      attr_reader :object
+      include ::Crunchbase::Utilities::CbModel
 
       ROOT_LIST = 'entities'
 
-      def initialize(entity_id, model_name)
+      def initialize(entity_id, entity_type)
         @entity_id = entity_id
-        @object = model_name.new
+        @entity_type = entity_type
       end
 
       # Will include all attribute from API document
       def fetch
-        object.parse_response(entity(
-                                root_uri,
-                                field_ids: object.field_ids.join(',')
-                              ))
+        cbobject.parse_response(entity(
+                                  entity_request_uri,
+                                  field_ids: cbobject.field_ids.join(',')
+                                ))
       end
 
       # Only include a part basis fields of endpoint
       def fetch_cards(card_names = [])
-        object.parse_cards_response(entity(
-                                      root_uri,
-                                      field_ids: object.basis_fields.join(','),
-                                      cards: (object.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)
-        object.parse_response(entity(
-                                root_uri(name: __method__, id: 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(
+                                  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, object.class::RESOURCE_LIST,
-          @entity_id, args[:name], args[:id]
+          ROOT_LIST, kclass_name::RESOURCE_LIST,
+          @entity_id, args[:name], args[:card_id]
         ].compact.join('/')
       end
     end

data/lib/crunchbase/models.rb

@@ -3,13 +3,23 @@
 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'
+    autoload :Acquisition,                  'crunchbase/models/acquisition'
     autoload :Investment,                   'crunchbase/models/investment'
     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/acquisition.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class Acquisition < Entity
+      RESOURCE_LIST = 'acquisitions'
+
+      def field_ids
+        %w[
+          acquiree_categories
+          acquiree_last_funding_type
+          acquiree_locations
+          acquiree_num_funding_rounds
+          acquiree_revenue_range
+          acquiree_short_description
+          acquirer_categories
+          acquirer_funding_total
+          acquirer_identifier
+          acquirer_locations
+          acquirer_num_funding_rounds
+          acquirer_short_description
+          created_at
+          disposition_of_acquired
+          entity_def_id
+          num_relationships
+          rank
+          rank_acquisition
+          status
+          terms
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          permalink
+          identifier
+          announced_on
+          completed_on
+          acquisition_type
+          price
+          short_description
+          acquiree_funding_total
+          acquiree_identifier
+          acquirer_revenue_range
+        ]
+      end
+
+      def full_cards
+        %w[
+          acquiree_organization
+          acquirer_organization
+          press_references
+        ]
+      end
+    end
+  end
+end