crunchbase4 0.1.0 → 0.1.5

data/lib/crunchbase/searches/client.rb

@@ -1,29 +1,80 @@
 # frozen_string_literal: true
 
+require_relative '../utilities/request'
+require_relative '../utilities/cb_model'
+
 module Crunchbase
   # Whole Searches endpoints
   module Searches
     # Send request for entities endpoints
+    #
+    # API doc:
+    #   https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.1#/Search/post_searches_organizations
+    #
+    # Notes
+    #   1. Only can filter `Searchable: Yes` fields
+    #   2. 'name', 'website' can not use
     class Client
       include ::Crunchbase::Utilities::Request
+      include ::Crunchbase::Utilities::CbModel
+
+      attr_accessor :total_count, :count, :entities, :entity_type, :conditions
 
       ROOT_LIST = 'searches'
       LIMIT = 100
 
-      def initialize(field_id, value)
-        @field_id = field_id
-        @value = value
+      def initialize(conditions, entity_type)
+        @conditions = conditions
+        @entity_type = entity_type
       end
 
       # Will include all attribute from API document
-      def search
-        search(root_uri, query_conditions)
+      def searches
+        wrapping!(
+          search(
+            root_uri,
+            data_raw.to_s.gsub('=>', ':')
+          )
+        )
       end
 
       private
 
+      def wrapping!(response)
+        query_results = search_results(response.dig('entities'))
+
+        self.total_count  = response['count']
+        self.entities     = query_results
+        self.count        = query_results.size
+        self
+      end
+
+      def search_results(entities)
+        entities.each_with_object([]) do |entity, objects|
+          objects << cbobject.parse_response(entity, field_ids)
+        end
+      end
+
       def root_uri
-        [ROOT_LIST, endpoint].compact.join('/')
+        [ROOT_LIST, kclass_name::RESOURCE_LIST].compact.join('/')
+      end
+
+      # Post request raw datas
+      def field_ids
+        @conditions['field_ids'] || cbobject.basis_fields
+      end
+
+      def limit
+        @conditions['limit'] || LIMIT
+      end
+
+      def data_raw
+        {
+          'field_ids' => field_ids,
+          'order' => @conditions['order'],
+          'query' => @conditions['query'],
+          'limit' => limit
+        }
       end
     end
   end

data/lib/crunchbase/utilities/autocomplete.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative '../autocompletes/client'
+
+module Crunchbase
+  # Utilities
+  module Utilities
+    # Autocomplete on Searches
+    module Autocomplete
+      # endpoint: /autocompletes
+      #
+      #  Suggests matching Identifier entities based on the query and entity_def_ids provided.
+      #
+      #  query * string
+      #     Value to perform the autocomplete search with.
+      #  collection_ids string
+      #     A comma separated list of collection ids to search against.
+      #     Leaving this blank means it will search across all identifiers.
+      #     Entity defs can be constrained to specific facets by providing them as facet collections.
+      #     Relationship collections will resolve to their underlying entity def.
+      #
+      #     Collection ids are:
+      #       organizations, people, funding_rounds, acquisitions, investments, events,
+      #       press_references, funds, event_appearances, ipos, ownerships, categories,
+      #       category_groups, locations, jobs
+      #  limit integer
+      #     Number of results to retrieve; default = 10, max = 25
+      #
+      #
+      #  Example for organizations
+      #
+      #  raw_data = {
+      #     query: keyword,
+      #     collection_ids: 'organizations'
+      #  }
+      def autocomplete(keyword, **args)
+        crunchbase_autocompletes(wrapper_autocompletes_data(keyword, args))
+      end
+
+      private
+
+      def crunchbase_autocompletes(raw_data)
+        Crunchbase::Autocompletes::Client.new(raw_data).autocompletes
+      end
+
+      def wrapper_autocompletes_data(keyword, **args)
+        { query: keyword }.merge(args)
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/cb_model.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Utilities
+  module Utilities
+    # API Request
+    module CbModel
+      attr_accessor :entity_type
+
+      module_function
+
+      def cbobject
+        kclass_name.new
+      end
+
+      def kclass_name
+        @kclass_name ||= exact_kclass_object
+      end
+
+      def exact_kclass_object
+        return entity_type if entity_type.is_a?(Class)
+
+        cb_type = [
+          'Crunchbase',
+          'Models',
+          entity_type.split('_').map(&:capitalize).join
+        ].join('::')
+        Kernel.const_get("::#{cb_type}")
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/deleted_entities.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../deleted_entities/client'
+
+module Crunchbase
+  # Utilities
+  module Utilities
+    # Autocomplete on Searches
+    module DeletedEntities
+      # endpoint: /deleted_entities
+      #
+      #   Retrieve deleted entities
+      #   Retrieve deleted entities for a collection id
+      #
+      # API doc:
+      #   https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.1#/Deleted%20Entities/get_deleted_entities
+      #
+      # Parameters:
+      #   collection_ids: string
+      #     Filter by collection id(s). Comma separated list of collection ids.
+      #       E.g.
+      #         organizations, people, funding_rounds, acquisitions, investments,
+      #         events, press_references, funds, event_appearances, ipos, ownerships,
+      #         categories, category_groups, locations, jobs
+      #   before_id: string
+      #     Used to paginate search results to the previous page. before_id should be the uuid of the first item in the current page.
+      #       May not be provided simultaneously with after_id.
+      #   after_id: string
+      #     Used to paginate search results to the next page. after_id should be the uuid of the last item in the current page.
+      #       May not be provided simultaneously with before_id.
+      #   limit: integer
+      #     Number of rows to return. Default is 100, min is 1, max is 1000.
+      #   deleted_at_order: string
+      #     Direction of sorting by deleted_at property
+      #       Available values : asc, desc
+      def deleted_entities(**args)
+        crunchbase_deleted_entities(args)
+      end
+
+      private
+
+      def crunchbase_deleted_entities(args)
+        Crunchbase::DeletedEntities::Client.new(args).deleted_entities
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/entity_endpoints.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+module Crunchbase
+  # Utilities
+  module Utilities
+    # All Entity API endpoints
+    module EntityEndpoints
+      # For Entity
+      #
+      # 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.
+
+      # Lookup an Organization or single card
+      def organization(entity_id, **card_args)
+        lookup_for('organization', entity_id, card_args)
+      end
+
+      # Lookup Organization's all cards
+      def organization_cards(entity_id, cards: [])
+        entities('organization', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup a Person or single card
+      def person(entity_id, **card_args)
+        lookup_for('person', entity_id, card_args)
+      end
+
+      # Lookup Person's all cards
+      def person_cards(entity_id, cards: [])
+        entities('person', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup a Funding Round or single card
+      def funding_round(entity_id, **card_args)
+        lookup_for('funding_round', entity_id, card_args)
+      end
+
+      # Lookup Funding Round's all cards
+      def funding_round_cards(entity_id, cards: [])
+        entities('funding_round', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup an Acquisition or Single card
+      def acquisition(entity_id, **card_args)
+        lookup_for('acquisition', entity_id, card_args)
+      end
+
+      # Lookup Acquisition's all card
+      def acquisition_cards(entity_id, cards: [])
+        entities('acquisition', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup an Investment or Single card
+      def investment(entity_id, **card_args)
+        lookup_for('investment', entity_id, card_args)
+      end
+
+      # Lookup Investment's all card
+      def investment_cards(entity_id, cards: [])
+        entities('investment', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup an PressReference or Single card
+      def press_reference(entity_id, **card_args)
+        lookup_for('press_reference', entity_id, card_args)
+      end
+
+      # Lookup PressReference's all card
+      def press_reference_cards(entity_id, cards: [])
+        entities('press_reference', entity_id).fetch_cards(cards)
+      end
+
+      # Lookup an Ipo or Single card
+      def ipo(entity_id, **card_args)
+        lookup_for('ipo', entity_id, card_args)
+      end
+
+      # Lookup Ipo's all card
+      def ipo_cards(entity_id, cards: [])
+        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_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, card_args)
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/request.rb

@@ -2,37 +2,76 @@
 
 require 'faraday'
 require 'faraday_middleware'
+require 'faraday_curl'
+require 'logger'
+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
 
+      # Autocompletes endpoint
+      def get(uri, *args)
+        fetch_request(uri, *args)
+      end
+
+      def deleted(uri, *args)
+        fetch_request(uri, *args)
+      end
+
+      # Entity endpoints
+      #
+      #   https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.1#/Entity/get_entities_organizations__entity_id_
       def entity(uri, *args)
-        response = Faraday.new(url: BASE_URI, headers: headers) do |faraday|
+        fetch_request(uri, *args)
+      end
+
+      # Search endpoints
+      #
+      #   https://app.swaggerhub.com/apis-docs/Crunchbase/crunchbase-enterprise_api/1.0.1#/Search/post_searches_organizations
+      def search(uri, args)
+        response = Faraday.new(url: BASE_URI, headers: post_headers) do |faraday|
           faraday.adapter Faraday.default_adapter
           faraday.response :json
-        end.get(uri, *args)
+          faraday.request :curl, ::Logger.new(STDOUT), :warn if debug_mode?
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+        end.post(uri, args)
 
         return response.body if response.status == 200
 
-        raise Error, response.reason_phrase
+        raise Error, response.body[0]['message']
       end
 
-      def search(uri, args)
+      private
+
+      def fetch_request(uri, *args)
         response = Faraday.new(url: BASE_URI, headers: headers) do |faraday|
           faraday.adapter Faraday.default_adapter
           faraday.response :json
-        end.post(uri, args)
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true if debug_mode?
+        end.get(uri, *args)
 
         return response.body if response.status == 200
 
-        raise Error, response.reason_phrase
+        raise Error, response.status == 400 ? response.body[0]['message'] : response.body['error']
       end
 
-      private
+      def debug_mode?
+        Crunchbase.config.debug || false
+      end
+
+      def post_headers
+        headers.merge(
+          'Content-Type' => 'application/json'
+        )
+      end
 
       def headers
         {

data/lib/crunchbase/utilities/response.rb

@@ -10,18 +10,20 @@ module Crunchbase
       def dynamic_attributes(object, attribute_names, response)
         attribute_names.each do |attribute_name|
           attribute_value = field_value(attribute_name, response)
+          dynamic_define_method(object, attribute_name, attribute_value)
+        end
 
-          # Manually creates methods for both getter and setter and then
-          #   sends a message to the new setter with the attribute_value
-          object.class.send(:define_method, "#{attribute_name}=".to_sym) do |value|
-            instance_variable_set('@' + attribute_name, value)
-          end
+        [attribute_names & special_attributes].flatten.each do |attribute_name|
+          attribute_names.delete(attribute_name)
+          hash_datas = response&.dig(attribute_name)
 
-          object.class.send(:define_method, attribute_name.to_sym) do
-            instance_variable_get('@' + attribute_name.to_s)
-          end
+          values = hash_datas&.map { |k, v| v if %w[uuid permalink value].include?(k) }&.compact || []
+          dynamic_define_method(object, attribute_name, values)
+          hash_datas&.keys&.each do |key|
+            next unless %w[uuid permalink].include?(key)
 
-          object.send("#{attribute_name}=".to_sym, attribute_value)
+            dynamic_define_method(object, key, hash_datas&.dig(key))
+          end
         end
 
         object
@@ -29,13 +31,32 @@ module Crunchbase
 
       private
 
+      def dynamic_define_method(object, attribute_name, attribute_value)
+        # Manually creates methods for both getter and setter and then
+        #   sends a message to the new setter with the attribute_value
+        object.class.send(:define_method, "#{attribute_name}=".to_sym) do |value|
+          instance_variable_set('@' + attribute_name, value)
+        end
+
+        object.class.send(:define_method, attribute_name.to_sym) do
+          instance_variable_get('@' + attribute_name.to_s)
+        end
+
+        object.send("#{attribute_name}=".to_sym, attribute_value)
+      end
+
+      # This is hash attributes
+      #
+      #   1. identifier
+      def special_attributes
+        %w[identifier]
+      end
+
       def field_value(name, data)
         value = data.dig(name)
 
         return value if value.nil? || value.is_a?(String)
-        if value.is_a?(Array) && value[0].is_a?(Hash) && value[0].keys.include?('value')
-          return value.collect { |e| e.dig('value') }
-        end
+        return value.collect { |e| e.dig('value') } if value.is_a?(Array) && value[0].is_a?(Hash) && value[0].keys.include?('value')
         return value.dig('value') if value.is_a?(Hash) && value.keys.include?('value')
 
         value