crunchbase4 0.1.2 → 0.1.7

data/lib/crunchbase/models/job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the Principal data from API
+    class Job < Entity
+      RESOURCE_LIST = 'jobs'
+
+      def field_ids
+        %w[
+          created_at
+          employee_featured_order
+          entity_def_id
+          identifier
+          short_description
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          name
+          title
+          started_on
+          ended_on
+          permalink
+          job_type
+          is_current
+          organization_identifier
+          person_identifier
+        ]
+      end
+
+      def full_cards
+        %w[
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/organization.rb

@@ -134,6 +134,16 @@ module Crunchbase
           headquarters_address
         ]
       end
+
+      def employees_range
+        Crunchbase::Utils::NUM_EMPLOYEES_ENUM[num_employees_enum]
+      end
+
+      private
+
+      def custom_fields
+        %w[employees_range]
+      end
     end
   end
 end

data/lib/crunchbase/models/ownership.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the Ownership data from API
+    class Ownership < Entity
+      RESOURCE_LIST = 'ownerships'
+
+      def field_ids
+        %w[
+          created_at
+          entity_def_id
+          identifier
+          updated_at
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          uuid
+          permalink
+          name
+          ownee_identifier
+          owner_identifier
+          ownership_type
+        ]
+      end
+
+      def full_cards
+        %w[
+          child_organization
+          parent_organization
+          press_references
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/models/principal.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module Crunchbase
+  # Get the Entities data from API
+  module Models
+    # Get the Principal data from API
+    class Principal < Entity
+      RESOURCE_LIST = 'principals'
+
+      def field_ids
+        %w[
+          category_groups
+          created_at
+          delisted_on
+          description
+          died_on
+          entity_def_id
+          equity_funding_total
+          exited_on
+          facet_ids
+          first_name
+          founded_on
+          founder_identifiers
+          funding_stage
+          funding_total
+          gender
+          hub_tags
+          identifier
+          image_id
+          image_url
+          investor_identifiers
+          ipo_status
+          last_equity_funding_total
+          last_equity_funding_type
+          last_funding_at
+          last_funding_total
+          last_funding_type
+          last_name
+          layout_id
+          location_group_identifiers
+          location_identifiers
+          num_alumni
+          num_articles
+          num_employees_enum
+          num_enrollments
+          num_event_appearances
+          num_exits
+          num_exits_ipo
+          num_founded_organizations
+          num_founders
+          num_funding_rounds
+          num_funds
+          num_investments
+          num_investments_funding_rounds
+          num_investors
+          num_jobs
+          num_lead_investments
+          num_lead_investors
+          num_partner_investments
+          num_portfolio_organizations
+          program_application_deadline
+          program_duration
+          program_type
+          rank_delta_d30
+          rank_delta_d7
+          rank_delta_d90
+          rank_principal
+          revenue_range
+          school_method
+          school_program
+          school_type
+          status
+          stock_exchange_symbol
+          stock_symbol
+          updated_at
+          went_public_on
+        ] + basis_fields
+      end
+
+      def basis_fields
+        %w[
+          name
+          uuid
+          website
+          short_description
+          operating_status
+          permalink
+          permalink_aliases
+          phone_number
+          primary_job_title
+          primary_organization
+          contact_email
+          aliases
+          born_on
+          closed_on
+          categories
+          company_type
+          linkedin
+          twitter
+          facebook
+          investor_stage
+          investor_type
+        ]
+      end
+
+      def full_cards
+        %w[
+        ]
+      end
+    end
+  end
+end

data/lib/crunchbase/utilities/autocomplete.rb

@@ -33,33 +33,18 @@ module Crunchbase
       #     query: keyword,
       #     collection_ids: 'organizations'
       #  }
-      def autocomplete_organizations(keyword)
-        autocompletes(wrapper_query_data(keyword, 'organizations'))
-      end
-
-      def autocomplete_people(keyword)
-        autocompletes(wrapper_query_data(keyword, 'people'))
-      end
-
-      def autocomplete_funding_rounds(keyword)
-        autocompletes(wrapper_query_data(keyword, 'funding_rounds'))
-      end
-
-      def autocomplete_press_references(keyword)
-        autocompletes(wrapper_query_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_query_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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../deleted_entities/client'
+
 module Crunchbase
   # Utilities
   module Utilities
@@ -9,7 +11,37 @@ module Crunchbase
       #
       #   Retrieve deleted entities
       #   Retrieve deleted entities for a collection id
-      def deleted_entities(collection_id: nil); end
+      #
+      # 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

@@ -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,63 +27,83 @@ 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
-      def person_cards(entity_id)
-        entities('person', entity_id).fetch_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_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
-      def funding_round_cards(entity_id)
-        entities('funding_round', entity_id).fetch_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_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
-      def acquisition_cards(entity_id)
-        entities('acquisition', entity_id).fetch_cards
+      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_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
-      def investment_cards(entity_id)
-        entities('investment', entity_id).fetch_cards
+      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_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
-      def press_reference_cards(entity_id)
-        entities('press_reference', entity_id).fetch_cards
+      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_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
-      def ipo_cards(entity_id)
-        entities('ipo', entity_id).fetch_cards
+      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
@@ -90,11 +112,13 @@ module Crunchbase
         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
 
@@ -18,6 +22,10 @@ module Crunchbase
         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_
@@ -52,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?