crunchbase4 0.1.0

data/lib/crunchbase.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'crunchbase/version'
+
+require 'crunchbase/config'
+require 'crunchbase/utilities'
+require 'crunchbase/client'
+require 'crunchbase/entities'
+require 'crunchbase/searches'
+require 'crunchbase/models'
+require 'crunchbase/errors'
+
+module Crunchbase
+  API_VERSION   = 'v4'
+  BASE_URI      = "https://api.crunchbase.com/api/#{API_VERSION}/"
+end

data/lib/crunchbase/client.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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
+  end
+end

data/lib/crunchbase/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+# Root Crunchbase
+module Crunchbase
+  # Config
+  class Config
+    include Singleton
+    attr_accessor :user_key
+  end
+
+  def self.config
+    yield Config.instance if block_given?
+
+    Config.instance
+  end
+end

data/lib/crunchbase/entities.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Entities API
+  module Entities
+    autoload :Client, 'crunchbase/entities/client'
+  end
+end

data/lib/crunchbase/entities/client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Whole entities endpoints
+  module Entities
+    # Send request for entities endpoints
+    class Client
+      include ::Crunchbase::Utilities::Request
+
+      attr_reader :object
+
+      ROOT_LIST = 'entities'
+
+      def initialize(entity_id, model_name)
+        @entity_id = entity_id
+        @object = model_name.new
+      end
+
+      # Will include all attribute from API document
+      def fetch
+        object.parse_response(entity(
+                                root_uri,
+                                field_ids: object.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(',')
+                                    ))
+      end
+
+      def cards(card_id)
+        object.parse_response(entity(
+                                root_uri(name: __method__, id: card_id)
+                              ))
+      end
+
+      private
+
+      def root_uri(args = {})
+        [
+          ROOT_LIST, object.class::RESOURCE_LIST,
+          @entity_id, args[:name], args[:id]
+        ].compact.join('/')
+      end
+    end
+  end
+end

data/lib/crunchbase/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  class Error < StandardError; end
+end

data/lib/crunchbase/models.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Models
+  module Models
+    autoload :Entity,                       'crunchbase/models/entity'
+    autoload :Organization,                 'crunchbase/models/organization'
+    autoload :Person,                       'crunchbase/models/person'
+    autoload :FundingRound,                 'crunchbase/models/funding_round'
+    autoload :Investment,                   'crunchbase/models/investment'
+    autoload :PressReference,               'crunchbase/models/press_reference'
+    autoload :CategoryGroup,                'crunchbase/models/category_group'
+    autoload :Category,                     'crunchbase/models/category'
+  end
+end

data/lib/crunchbase/models/category.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class Category < Entity
+      RESOURCE_LIST = 'categories'
+
+      def field_ids
+        %w[
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+        ]
+      end
+
+      def full_cards
+        %w[
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/category_group.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class CategoryGroup < Entity
+      RESOURCE_LIST = 'category_groups'
+
+      def field_ids
+        %w[
+          categories
+          created_at
+          entity_def_id
+          identifier
+          rank
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          name
+        ]
+      end
+
+      def full_cards
+        %w[]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/entity.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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)
+        dynamic_attributes(self, field_ids, response.dig('properties'))
+      end
+
+      def parse_cards_response(response)
+        parse_response(response, response.dig('properties'))
+        # response.dig('cards')
+      end
+
+      def as_json
+        fields.each_with_object({}) { |item, hash| hash[item] = send(item) }
+      end
+    end
+  end
+end

data/lib/crunchbase/models/funding_round.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class FundingRound < Entity
+      RESOURCE_LIST = 'funding_rounds'
+
+      def field_ids
+        %w[
+          created_at
+          entity_def_id
+          funded_organization_categories
+          funded_organization_description
+          funded_organization_funding_stage
+          funded_organization_funding_total
+          funded_organization_identifier
+          funded_organization_location
+          funded_organization_revenue_range
+          identifier
+          image_id
+          investor_identifiers
+          is_equity
+          lead_investor_identifiers
+          num_partners
+          num_relationships
+          permalink
+          pre_money_valuation
+          rank
+          rank_funding_round
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          name
+          announced_on
+          closed_on
+          investment_stage
+          investment_type
+          money_raised
+          target_money_raised
+          num_investors
+          short_description
+        ]
+      end
+
+      def full_cards
+        %w[
+          investments
+          lead_investors
+          investors
+          organization
+          partners
+          press_references
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/investment.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the person data from API
+    class Investment < Entity
+      RESOURCE_LIST = 'investments'
+
+      def field_ids
+        %w[
+          created_at
+          entity_def_id
+          identifier
+          investor_identifier
+          is_lead_investor
+          funding_round_identifier
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          name
+          permalink
+          money_invested
+          investor_stage
+          investor_type
+          funding_round_money_raised
+          organization_identifier
+          partner_identifiers
+          announced_on
+        ]
+      end
+
+      def full_cards
+        %w[
+          investor
+          organization
+          funding_round
+          partner
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/organization.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Organization data from API
+  module Models
+    # Build Organization API
+    class Organization < Entity
+      RESOURCE_LIST = 'organizations'
+
+      def basis_fields
+        %w[
+          uuid
+          identifier
+          permalink
+          permalink_aliases
+          name
+          legal_name
+          aliases
+          website
+          linkedin
+          twitter
+          rank_org
+          short_description
+          description
+          rank_org_company
+        ]
+      end
+
+      def field_ids
+        %w[
+          acquirer_identifier
+          categories
+          category_groups
+          closed_on
+          company_type
+          contact_email
+          created_at
+          delisted_on
+          demo_days
+          entity_def_id
+          equity_funding_total
+          exited_on
+          facebook
+          facet_ids
+          founded_on
+          founder_identifiers
+          funding_stage
+          funding_total
+          funds_total
+          image_id
+          image_url
+          investor_identifiers
+          investor_stage
+          investor_type
+          ipo_status
+          last_equity_funding_total
+          last_equity_funding_type
+          last_funding_at
+          last_funding_total
+          last_funding_type
+          layout_id
+          listed_stock_symbol
+          location_group_identifiers
+          location_identifiers
+          num_acquisitions
+          num_alumni
+          num_articles
+          num_current_advisor_positions
+          num_current_positions
+          num_employees_enum
+          num_enrollments
+          num_event_appearances
+          num_exits
+          num_exits_ipo
+          num_founder_alumni
+          num_founders
+          num_funding_rounds
+          num_funds
+          num_investments
+          num_investments_funding_rounds
+          num_investors
+          num_lead_investments
+          num_lead_investors
+          num_past_positions
+          num_portfolio_organizations
+          num_relationships
+          num_sub_organizations
+          operating_status
+          override_layout_id
+          owner_identifier
+          phone_number
+          program_application_deadline
+          program_duration
+          program_type
+          rank_delta_d30
+          rank_delta_d7
+          rank_delta_d90
+          rank
+          rank_org_school
+          rank_principal
+          rank_principal_investor
+          revenue_range
+          school_method
+          school_program
+          school_type
+          status
+          stock_exchange_symbol
+          stock_symbol
+          updated_at
+          went_public_on
+        ] + basis_fields
+      end
+
+      def full_cards
+        %w[
+          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
+        ]
+      end
+    end
+  end
+end