crunchbase4 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb7a01707e086f0d73d6a92807f4d0a9e2dfab44e73647254781103792817373
-  data.tar.gz: b61240087a0344caf96bb065fa9c309f83e19d2357d805f74278cf2bda9381cc
+  metadata.gz: 305bc09f8a83e2c4413f2e1dd7081b371b118e6e40727c9770e9c816f50d7e5b
+  data.tar.gz: e8c2c700770b5e08be5a69e613c6381877b9d1a5b551fe96114185eae2b8ce26
 SHA512:
-  metadata.gz: b08389e81858a042b5204787ef8c25a78f712f23688cfb40e81a428298205748158d2e5380a9a24551b896c103212dab8b10b183e4d5ef8d357fb0b0c02f3515
-  data.tar.gz: cc99c470c8838170978d862a738283ca2481bbf75deeeb9e4760b46902321ddd3469e31e6e01183917cea54794a20187c0b1648ba2962ce675a1bf6ccac3bea1
+  metadata.gz: f6423c5de66af723a227aac874dafb6815921cd7e3ee4efe1015adaf551b46ff55eac7335b496caae71909e0507e210139579507f516d2f2090fdd8cc4d0fb1d
+  data.tar.gz: 7601a5f4c815c59c12c855694d7a7e497456eed498c1a1c15d396fec9197bf7c6c3fc0d276d3dbcf7d8acb2a2f0cf85cb63874c0c68cdedc8c49b6b07d0e1c5b

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.1.3] - 2020-06-09
+
+### Added
+- Implemented `deleted_entities` API to allow user get deleted entities by collection_ids
+- Implemented `fetch(entity_id, card_id)` API, allow user get the entity with card_id data
+
 ## [0.1.2] - 2020-06-07
 
 ### Added
@@ -9,7 +15,7 @@ All notable changes to this project will be documented in this file.
   - organzations
   - people
   - funding rounds
-- Implemented autocomplete API to allow user filter entities by keyword
+- Implemented `autocompletes` API to allow user filter entities by keyword
   - organzations
   - people
   - funding rounds
@@ -31,4 +37,4 @@ All notable changes to this project will be documented in this file.
 
 ## [0.0.0] - 2020-06-01
 
-- Learning the Crunchbase V4 document and ready to create the new Gem
+- Learning the Crunchbase V4 API changes then creating the Gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    crunchbase4 (0.1.2)
+    crunchbase4 (0.1.3)
       faraday
       faraday_curl
       faraday_middleware

data/README.md

@@ -1,6 +1,6 @@
 # Crunchbase
 
-Crunchbase is a ruby wrapper base on Crunchbase V4 API. It provides easy to get the API data by each endpoint. [CB-v4 doc](https://app.swaggerhub.com/apis/Crunchbase/crunchbase-enterprise_api/1.0.1)
+Crunchbase is a ruby wrapper based on Crunchbase V4 API. it provides easy to get the API data by each endpoint. [CB v4 DOC](https://app.swaggerhub.com/apis/Crunchbase/crunchbase-enterprise_api/1.0.1)
 
 [![Gem Version](https://badge.fury.io/rb/crunchbase4.svg)](https://badge.fury.io/rb/crunchbase4)
 [![Build Status](https://travis-ci.org/encoreshao/crunchbase4.svg?branch=master)](https://travis-ci.org/encoreshao/crunchbase4)
@@ -23,34 +23,97 @@ Or install it yourself as:
 
 ## Getting Started
 
-### Configure your API certificate
+#### Configure your certificate for API
 
-```
+```ruby
 require 'crunchbase4'
 
 CB_CONFIG = YAML.load(File.read('crunchbase.yml'))
-Crunchbase.config do |c|
-  c.user_key = CB_CONFIG['user_key']
-end
-
-OR
-
 Crunchbase.config.user_key = CB_CONFIG['user_key']
 ```
 
 ## Usage
 
-### The first step is to build an API client
+#### Class: `Client` for API
 
 ```
 pry(main)> client = Crunchbase::Client.new
 ```
 
+#### API request for endpoint we completed
+
+- [Entity](https://github.com/ekohe/crunchbase4#entity)
+  - organizations
+  - people
+  - funding_rounds
+- [Searches](https://github.com/ekohe/crunchbase4#search)
+- [Autocompletes](https://github.com/ekohe/crunchbase4#autocompletes)
+- [Deleted Entities](https://github.com/ekohe/crunchbase4#deleted-entities)
+
+```ruby
+<!-- Entity -->
+response = client.organization('ekohe')
+response = client.organization('ekohe', 'ipos')
+response = client.person('mark-zuckerberg')
+response = client.person('mark-zuckerberg', 'participated_investments')
+response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
+response = client.funding_round('371c20af8aa94bcba8da0694d138f247', 'investments')
+response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
+
+<!-- Search -->
+client.search_organizations(query_data)
+client.search_people(query_data)
+client.search_funding_rounds(query_data)
+client.recent_updates({
+                        scope_name: 'organization',
+                        field_ids: %w[name website permalink],
+                        date: '2020-05-05',
+                        limit: 100
+                      })
+
+<!-- Autocompletes -->
+response = client.autocomplete_organizations('ekohe')
+response = client.autocomplete_people('encore')
+response = client.autocomplete_funding_rounds('facebook')
+
+<!-- Deleted Entities -->
+response = client.deledeted_organizations
+response = client.deledeted_people
+response = client.deledeted_funding_rounds
+```
+
+#### Module: Utils
+
+* We return all the original data from CrunchBase without any conversion. So you want to use the converted data, you can use this tool to convert.
+
+```ruby
+pry(main)> Crunchbase::Utils.constants
+=> [:QUERY_OPERATORS,
+ :COMPANY_TYPES,
+ :FACET_IDS,
+ :IPO_STATUS,
+ :FUNDING_STAGES,
+ :FUNDING_TYPES,
+ :CURRENCY_ENUM,
+ :DATE_PRECISIONS,
+ :LAYOUT_IDS,
+ :NUM_EMPLOYEES_ENUM,
+ :OPERATING_STATUS,
+ :PROGRAM_TYPES,
+ :REVENUE_RANGES,
+ :SCHOOL_METHODS,
+ :SCHOOL_TYPES,
+ :STATUS,
+ :STOCK_EXCHANGE_SYMBOLS]
+pry(main)> Crunchbase::Utils::COMPANY_TYPES
+=> {"for_profit"=>"For Profit", "non_profit"=>"Non-profit"}
+```
+
 ### Entity
 
 ####  Get the organization data
 
-```
+```ruby
 pry(main)> response = client.organization('ekohe')
 => #<Crunchbase::Models::Organization:0x00007fbc5cfdf2f8
  @categories=["Apps", "Artificial Intelligence", "Big Data", "E-Commerce", "Enterprise Software", "FinTech", "iOS", "Retail", "UX Design"],
@@ -68,9 +131,9 @@ pry(main)> response.permalink
 
 Or, if you want to use json data, please call `response.as_json` in your project.
 
-#### Get the person data
+##### Get the person data
 
-```
+```ruby
 pry(main)> response = client.person('mark-zuckerberg')
 => #<Crunchbase::Models::Person:0x00007ffbf201d178
  @aliases=["Zuck"],
@@ -89,9 +152,9 @@ pry(main)> response.permalink
 => "mark-zuckerberg"
 ```
 
-#### Get the funding round data
+##### Get the funding round data
 
-```
+```ruby
 => #<Crunchbase::Client:0x00007f8806824c28>
 pry(main)> response = client.funding_round('371c20af-8aa9-4bcb-a8da-0694d138f247')
 => #<Crunchbase::Models::FundingRound:0x00007f8806b55ca8
@@ -113,9 +176,9 @@ pry(main)> response.uuid
 => "371c20af-8aa9-4bcb-a8da-0694d138f247"
 ```
 
-#### Get the acquisition data
+##### Get the acquisition data
 
-```
+```ruby
 pry(main)> response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
 => #<Crunchbase::Models::Acquisition:0x00007fa01134da60
  @acquiree_categories=["Communities", "Internet", "Photo Sharing", "Publishing", "Search Engine", "Social Media"],
@@ -130,9 +193,9 @@ pry(main)> response.acquiree_funding_total
 => 150949998
 ```
 
-#### Get the press reference data
+##### Get the press reference data
 
-```
+```ruby
 pry(main)> response = client.press_reference('0171b30e-9cf8-4ad5-8288-2993e4308e0f')
 => #<Crunchbase::Models::PressReference:0x00007fce2d33dbc0
  @activity_entities=["Facebook", "General Atlantic", "KKR", "Reliance Industries", "Vista Equity Partners"],
@@ -149,9 +212,9 @@ pry(main)> response = client.press_reference('0171b30e-9cf8-4ad5-8288-2993e4308e
  @uuid="0171b30e-9cf8-4ad5-8288-2993e4308e0f">
 ```
 
-#### Get the investment data
+##### Get the investment data
 
-```
+```ruby
 pry(main)> response = client.investment('1368da0c-07b0-46ef-9a86-b518367e60d6')
 => #<Crunchbase::Models::Investment:0x00007f8c15105830
  @announced_on="2013-06-30",
@@ -177,7 +240,7 @@ pry(main)> response = client.investment('1368da0c-07b0-46ef-9a86-b518367e60d6')
 
 * Search query parameters for each endpoint
 
-```
+```ruby
 {
   "field_ids": [],
   "query": [],
@@ -186,13 +249,13 @@ pry(main)> response = client.investment('1368da0c-07b0-46ef-9a86-b518367e60d6')
 }
 ```
 
-#### Get the latest updated entities
+##### Get the latest updated entities
 
 Allow user using the method `recent_updates(args)` to get recent updates for each endpoint on searches
 
-# Example to get recent updated organizations
+* Example to get recent updated organizations
 
-```
+```ruby
 args = {
   scope_name: 'organization',             # must
   date: '2020-05-05',                     # must
@@ -205,11 +268,11 @@ args = {
 response = client.recent_updates(args)
 ```
 
-#### Search organizations by query conditions and order
+##### Search organizations by query conditions and order
 
-* Step1: Needs to build the query conditions
+* building the query conditions
 
-```
+```ruby
 query_data = {
   'field_ids' => %w[
     name
@@ -253,7 +316,7 @@ query_data = {
 
 * Use `client` to send a request and parse response
 
-```
+```ruby
 pry(main)> response = client.search_organizations(query_data)
 => #<Crunchbase::Searches::Client:0x00007fdfc1ad6eb8
  @conditions=
@@ -294,15 +357,15 @@ pry(main)> response = client.search_organizations(query_data)
  @total_count=44871>
 ```
 
-- Get all entities:     `response.entities`
-- Get total count:      `response.total_count`
-- Get entities count:   `response.count`
+- Get entities: response.entities
+- Get total count: response.total_count
+- Get entities count: response.count
 
-#### Search people by query conditions and order
+##### Search people by query conditions and order
 
-* Step1: Needs to build the query conditions
+* building the query conditions
 
-```
+```ruby
 query_data = {
   'field_ids' => %w[
     first_name
@@ -342,7 +405,7 @@ query_data = {
 
 * Use `client` to send a request and parse response
 
-```
+```ruby
 pry(main)> response = client.search_people(query_data)
 => #<Crunchbase::Searches::Client:0x00007f9acca12d18
  @conditions=
@@ -362,15 +425,15 @@ pry(main)> response.total_count
 => 1
 ```
 
-## Autocompletes
+### Autocompletes
 
-### Allow users to filter by keyword from these endpoints
+##### Allow users to filter by keyword from these endpoints
 
 Search by keyword has been supported in "Organization", "People" and "Fund Round"
 
-1. Example: Search in an organization by keyword
+* Search in an organization by keyword
 
-```
+```ruby
 pry(main)> response = client.autocomplete_organizations('ekohe')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb34ce1e8
  @conditions={:query=>"ekohe", :collection_ids=>"organizations"},
@@ -400,9 +463,9 @@ pry(main)> response.count
 pry(main)> response.total_count
 ```
 
-2. Example: Search in an people by keyword
+* Search in an people by keyword
 
-```
+```ruby
 pry(main)> response = client.autocomplete_people('maxime')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb474f9c0
  @conditions={:query=>"maxime", :collection_ids=>"people"},
@@ -431,10 +494,11 @@ pry(main)> response.entities
 pry(main)> response.count
 pry(main)> response.total_count
 ```
-2. Example: Search in an funding rounds by keyword
 
-```
-pry(main)> pry(main)> response = client.autocomplete_funding_rounds('facebook')
+* Search in an funding rounds by keyword
+
+```ruby
+pry(main)> response = client.autocomplete_funding_rounds('facebook')
 => #<Crunchbase::Autocompletes::Client:0x00007fecb4dd66b8
  @conditions={:query=>"facebook", :collection_ids=>"funding_rounds"},
  @count=25,
@@ -463,38 +527,42 @@ pry(main)> response.count
 pry(main)> response.total_count
 ```
 
-## Development
+### Deleted Entities
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* Get deleted entities by collection_ids
 
-### Examples of API requests for each endpoint
+```ruby
+pry(main)> response = client.deleted_organizations
+=> #<Crunchbase::DeletedEntities::Client:0x00007fa9196b6498
+ @conditions={:collection_ids=>"organizations"},
+ @count=1000,
+ @entities=
+  [#<Crunchbase::Models::DeletedEntity:0x00007fa9197f9df0 @deleted_at="2020-06-06T11:51:34Z", @entity_def_id="organization", @identifier=[], @uuid="31e5d1dd-3a7d-4c8c-b7dc-4780d391bbc3">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa9197f8fb8 @deleted_at="2020-06-06T10:43:10Z", @entity_def_id="organization", @identifier=[], @uuid="31d2ba51-ef94-4039-a6fc-22e5c1f0ed80">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa9197f86a8 @deleted_at="2020-06-05T18:32:20Z", @entity_def_id="organization", @identifier=[], @uuid="3f105ec3-606c-4779-85c8-29ec78d67d2d">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981fd48 @deleted_at="2020-06-05T15:01:59Z", @entity_def_id="organization", @identifier=[], @uuid="e66d053a-86fa-4f5f-9c98-1d4b3ed0778d">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981f438 @deleted_at="2020-06-05T13:17:39Z", @entity_def_id="organization", @identifier=[], @uuid="014de711-a0b0-4e29-a8ce-5f8c2696d9af">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981eb28 @deleted_at="2020-06-05T13:09:11Z", @entity_def_id="organization", @identifier=[], @uuid="8b3102a2-04cc-4fb2-85cb-b2aa55662291">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981e218 @deleted_at="2020-06-05T11:47:50Z", @entity_def_id="organization", @identifier=[], @uuid="62ae4ffc-a999-4c09-8c42-eef26be606aa">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981d908 @deleted_at="2020-06-05T11:47:34Z", @entity_def_id="organization", @identifier=[], @uuid="7aa08989-f6ef-427c-96ac-7e1482a7eec1">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981cff8 @deleted_at="2020-06-05T11:46:13Z", @entity_def_id="organization", @identifier=[], @uuid="7a6a5e41-d396-437a-9dfb-8539ef554268">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91981c6e8 @deleted_at="2020-06-05T11:45:21Z", @entity_def_id="organization", @identifier=[], @uuid="10db5120-a638-40eb-b636-e7cca20708e0">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91982fd88 @deleted_at="2020-06-05T11:45:01Z", @entity_def_id="organization", @identifier=[], @uuid="86c09840-b344-4687-a5ee-e5ea851b0b94">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91982f478 @deleted_at="2020-06-05T11:44:07Z", @entity_def_id="organization", @identifier=[], @uuid="2ac345e0-f6a0-4352-b66b-3254d4616c87">,
+   #<Crunchbase::Models::DeletedEntity:0x00007fa91982eb68 @deleted_at="2020-06-05T11:43:23Z", @entity_def_id="organization", @identifier=[], @uuid="9fa9c806-bc1b-49e6-81f4-719cbfd7928e">,
+   ....]
+pry(main)> response.entities
+pry(main)> response.count
+pry(main)> response.total_count
 
+# Get deleted people and funding rounds
+pry(main)> response = client.deleted_people
+pry(main)> response = client.deleted_funding_rounds
 ```
-Crunchbase.config.user_key = 'user_key'
-client = Crunchbase::Client.new
-
-<!-- Entity -->
-response = client.organization('ekohe')
-response = client.person('mark-zuckerberg')
-response = client.funding_round('371c20af8aa94bcba8da0694d138f247')
-response = client.acquisition('7638eae9-07b7-4fc6-ad20-5d99de3ff928')
 
-<!-- Search -->
-client.search_organizations(query_data)
-client.search_people(query_data)
-client.search_funding_rounds(query_data)
-client.recent_updates({
-                        scope_name: 'organization',
-                        field_ids: %w[name website permalink],
-                        date: '2020-05-05',
-                        limit: 100
-                      })
+## Development
 
-<!-- Autocompletes -->
-response = client.autocomplete_organizations('ekohe')
-response = client.autocomplete_people('encore')
-response = client.autocomplete_funding_rounds('facebook')
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 ## Changelog
 

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')

data/lib/crunchbase/autocompletes/client.rb

@@ -26,7 +26,7 @@ module Crunchbase
 
       # Will include all attribute from API document
       def autocompletes
-        wrapping!(
+        wrapping_autocomplete_entities!(
           get(
             ROOT_LIST,
             autocompletes_parameters
@@ -36,7 +36,7 @@ module Crunchbase
 
       private
 
-      def wrapping!(response)
+      def wrapping_autocomplete_entities!(response)
         query_results = search_results(response.dig('entities'))
 
         self.total_count  = response['count']

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

@@ -28,17 +28,21 @@ module Crunchbase
 
       # 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(
+                                  root_uri,
+                                  field_ids: cbobject.basis_fields.join(','),
+                                  cards: (cbobject.full_cards & card_names).join(',')
+                                ), cbobject.basis_fields, card_names)
       end
 
       def cards(card_id)
+        raise Crunchbase::Error, 'Invalid card_id' unless cbobject.full_cards.include?(card_id)
+
         cbobject.parse_response(entity(
-                                  root_uri(name: __method__, id: card_id)
-                                ))
+                                  root_uri(name: __method__, id: card_id),
+                                  field_ids: cbobject.basis_fields.join(','),
+                                  card_field_ids: cbobject.card_model_mappings[card_id].new.field_ids.join(',')
+                                ), cbobject.basis_fields, [card_id])
       end
 
       private

data/lib/crunchbase/models.rb

@@ -5,6 +5,7 @@ module Crunchbase
   module Models
     autoload :Entity,                       'crunchbase/models/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'

data/lib/crunchbase/models/deleted_entity.rb

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

data/lib/crunchbase/models/entity.rb

@@ -13,20 +13,60 @@ module Crunchbase
         field_ids.map(&:to_sym)
       end
 
-      def parse_response(response, request_field_ids = [])
+      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 parse_cards_response(response)
-        parse_response(response, response.dig('properties'))
-        # response.dig('cards')
+      def setup_relationships(object, request_card_ids, response_cards)
+        request_card_ids.each do |card_id|
+          card_data = response_cards.dig(card_id)
+          next if card_data.nil? || card_data.empty?
+
+          card_model = card_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
+                           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
+
+      def card_model_mappings
+        {
+          'investments' => Crunchbase::Models::Investment,
+          'raised_investments' => Crunchbase::Models::Investment,
+          # 'participated_funds' => Crunchbase::Models::Fund,
+          'child_organizations' => Crunchbase::Models::Organization,
+          'participated_investments' => Crunchbase::Models::Investment,
+          # 'investors' => Crunchbase::Models::Investor,
+          'parent_organization' => Crunchbase::Models::Organization,
+          'raised_funding_rounds' => Crunchbase::Models::FundingRound,
+          'ipos' => Crunchbase::Models::Ipo,
+          # 'event_appearances' => Crunchbase::Models::EventAppearance,
+          # 'raised_funds' => Crunchbase::Models::Fund,
+          'acquiree_acquisitions' => Crunchbase::Models::Acquisition,
+          # 'parent_ownership' => Crunchbase::Models::Ownership,
+          # 'jobs' => Crunchbase::Models::Job,
+          # 'founders' => Crunchbase::Models::Founder,
+          # 'child_ownerships' => Crunchbase::Models::Ownership,
+          'participated_funding_rounds' => Crunchbase::Models::FundingRound,
+          'press_references' => Crunchbase::Models::PressReference
+          # 'headquarters_address' => Crunchbase::Models::Address,
+        }
+      end
     end
   end
 end

data/lib/crunchbase/utilities/autocomplete.rb

@@ -34,19 +34,19 @@ module Crunchbase
       #     collection_ids: 'organizations'
       #  }
       def autocomplete_organizations(keyword)
-        autocompletes(wrapper_query_data(keyword, 'organizations'))
+        autocompletes(wrapper_autocompletes_data(keyword, 'organizations'))
       end
 
       def autocomplete_people(keyword)
-        autocompletes(wrapper_query_data(keyword, 'people'))
+        autocompletes(wrapper_autocompletes_data(keyword, 'people'))
       end
 
       def autocomplete_funding_rounds(keyword)
-        autocompletes(wrapper_query_data(keyword, 'funding_rounds'))
+        autocompletes(wrapper_autocompletes_data(keyword, 'funding_rounds'))
       end
 
       def autocomplete_press_references(keyword)
-        autocompletes(wrapper_query_data(keyword, 'press_references'))
+        autocompletes(wrapper_autocompletes_data(keyword, 'press_references'))
       end
 
       private
@@ -55,7 +55,7 @@ module Crunchbase
         Crunchbase::Autocompletes::Client.new(raw_data).autocompletes
       end
 
-      def wrapper_query_data(keyword, collection_ids)
+      def wrapper_autocompletes_data(keyword, collection_ids)
         {
           query: keyword,
           collection_ids: collection_ids

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,53 @@ 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_organizations(args = {})
+        deleted_entities(wrapper_deleted_entities_data(args, 'organizations'))
+      end
+
+      def deleted_people(args = {})
+        deleted_entities(wrapper_deleted_entities_data(args, 'people'))
+      end
+
+      def deleted_funding_rounds(args = {})
+        deleted_entities(wrapper_deleted_entities_data(args, 'funding_rounds'))
+      end
+
+      def deleted_press_references(args = {})
+        deleted_entities(wrapper_deleted_entities_data(args, 'press_references'))
+      end
+
+      private
+
+      def deleted_entities(raw_data)
+        Crunchbase::DeletedEntities::Client.new(raw_data).deleted_entities
+      end
+
+      def wrapper_deleted_entities_data(args, collection_ids = nil)
+        args.merge!(collection_ids: collection_ids)
+      end
     end
   end
 end

data/lib/crunchbase/utilities/entity_endpoints.rb

@@ -30,8 +30,8 @@ module Crunchbase
       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
@@ -40,8 +40,8 @@ module Crunchbase
       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
@@ -50,8 +50,8 @@ module Crunchbase
       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
@@ -60,8 +60,8 @@ module Crunchbase
       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
@@ -70,8 +70,8 @@ module Crunchbase
       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
@@ -80,8 +80,8 @@ module Crunchbase
       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
 
       private

data/lib/crunchbase/utilities/request.rb

@@ -18,6 +18,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_

data/lib/crunchbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Crunchbase
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase4
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Encore Shao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Crunchbase is a ruby wrapper base on Crunchbase V4 API. It provides
+description: 'Crunchbase is a ruby wrapper base on Crunchbase V4 API. it provides
   easy to get the API data by each endpoint. '
 email:
 - encore@ekohe.com
@@ -135,6 +135,7 @@ files:
 - lib/crunchbase/autocompletes/client.rb
 - lib/crunchbase/client.rb
 - lib/crunchbase/config.rb
+- lib/crunchbase/deleted_entities/client.rb
 - lib/crunchbase/entities.rb
 - lib/crunchbase/entities/client.rb
 - lib/crunchbase/errors.rb
@@ -143,6 +144,7 @@ files:
 - lib/crunchbase/models/autocomplete_entity.rb
 - lib/crunchbase/models/category.rb
 - lib/crunchbase/models/category_group.rb
+- lib/crunchbase/models/deleted_entity.rb
 - lib/crunchbase/models/entity.rb
 - lib/crunchbase/models/funding_round.rb
 - lib/crunchbase/models/investment.rb