crunchbase-ruby-library 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59dae45ccc627c105545d3862e2978249476c664
-  data.tar.gz: 201f6b5b6e96b6ceb7c43f860f1479dc5bd39ba7
+  metadata.gz: 2b032af32aa76dd5da6cf9cdb2463bbee3cf0257
+  data.tar.gz: 74e32566892917c53c95aa26730a31c8791bbebf
 SHA512:
-  metadata.gz: 9fa95c9721d6a6b73f2d952992198897b59da4d2f7e68f8bfa8b081b25fb8796a889015a87cceebeaaa175ec2ca7fb49f23a45be778f5e87239d6614325e5550
-  data.tar.gz: e20fa1269b918d8fe6466a62c7539c9b81a919007ab60490c305277723252cfebdbe946a4a9e6223d51ea8cb063f8fc50be1cab54ad4a2cef5d89a6b8756d37c
+  metadata.gz: b210892b735f616b700fa57288d7d19d6c214e4f80c06de2acfec8b81b20ac328cbd3b75feed54eada18c5d7743aa1dd3e0c424faa0f137f163724738b8642c2
+  data.tar.gz: 8a3ad473ed48313fa8805377b766280f1ab67bed78eb2a4cedb77470d5040eb625c3860bcb505e9c1c674d75a13fff16ddd4ca85501328247d0f969190c07d6c

data/README.md

@@ -42,7 +42,7 @@ cCeate the file `config/initializers/crunchbase.rb` in your rails project and ad
     - Acquisitions
     - Funding Rounds
 
-#### Searching...
+#### Searching by...
 
     * client.search({query: "Google"}, 'organizations') # Full text search of an Organization's name, aliases
     * client.search({name: "Google"}, 'organizations') # Full text search limited to name and aliases
@@ -62,34 +62,58 @@ cCeate the file `config/initializers/crunchbase.rb` in your rails project and ad
         * pages
         * current_page
 
-### Get Organization && RelationShips by the permalink
+### Get Organization by the permalink
 
-    response = client.get('Organization', 'facebook')
+    => response = client.get('facebook', 'Organization')
 
     Relationship objects [ primary_image founders current_team investors owned_by sub_organizations headquarters offices products categories customers competitors members memberships funding_rounds investments acquisitions acquired_by ipo funds websites images videos news ]
 
-    # Methods - Get Organization with one relationship data
+    methods: Get Organization with one relationship data
 
-    1. response = client.get('Organization', 'facebook', 'PastTeam')
+    => response = client.get('facebook', 'Organization', 'PastTeam')
     past_team.results.collect { |p| [p.title, p.person.first_name] }
 
     ....
 
 ### Get Person by the permalink
 
-    person = client.get('Person', permalink)
-
-    #<Crunchbase::Model::Person:0x007fc185215f68 @type_name="Person", @uuid="a578dcf9859ec8b52182e3aa3c383b13", ...>
-
-    people = client.list('Person', page)
-
-    people.results
-
-    [ #<Crunchbase::Model::PersonSummary:...>,
-    #<Crunchbase::Model::PersonSummary: ...>,
-    #<Crunchbase::Model::PersonSummary: ...>,
-    #<Crunchbase::Model::PersonSummary: ...>
-    ...... ]
+    => person = client.get(permalink, 'Person')
+    => #<Crunchbase::Model::Person:0x007fc185215f68 @type_name="Person", @uuid="a578dcf9859ec8b52182e3aa3c383b13", ...>
+
+    => people = client.list('Person', page: page)
+    => people.results
+    => [
+        #<Crunchbase::Model::PersonSummary:...>,
+        #<Crunchbase::Model::PersonSummary: ...>,
+        #<Crunchbase::Model::PersonSummary: ...>,
+        #<Crunchbase::Model::PersonSummary: ...>
+        ......
+    ]
+    
+### Batch search
+Pass in an array of requests to perform a batch search. Following parameters should be present in each request: `type`, `uuid` and `relationships` (https://data.crunchbase.com/docs/using-the-api#batch-search-capabilities).<br/>
+Max 10 requests per search allowed.
+    
+    => requests = [
+        { type: 'Organization', uuid: 'valid_uuid', relationships: ["<relationship_name>"] },
+        { type: 'Person', uuid: 'valid_uuid', relationships: ["<relationship_name>"] },
+        { type: 'Organization', uuid: 'invalid_uuid', relationships: [] },
+    ]
+    => batch_search = client.batch_search(requests)
+    => batch_search = #<Crunchbase::Model::BatchSearch:0x007f9bd7e850d8 @results=[#<Crunchbase::Model::Organization:0x007f9bd7e84f98, ...>]>
+    => batch_search.results
+    => [
+        #<Crunchbase::Model::Organization:0x007f9bd7e84f98, ...>,
+        #<Crunchbase::Model::Person:0x007f9bda0d9d78, ...>,
+        #<Crunchbase::Model::Error:0x007fd6b6818758 @code="LA404", @message="Not Found - Entity invalid_uuid doesn't exist" ...> // Error object returned due to invalid uuid passed
+    ] 
+    
+
+### How to debug in the console
+
+    $ ruby bin/console OR ./bin/console
+    => client = Crunchbase::Client.new
+    => ...
 
 ### Contributing
 
@@ -101,4 +125,4 @@ cCeate the file `config/initializers/crunchbase.rb` in your rails project and ad
 
 ### Copyright
 
-Copyright © 2015-05 Encore Shao. See LICENSE for details.
+Copyright © 2017-10 Encore Shao. See LICENSE for details.

data/lib/crunchbase/api.rb

@@ -16,7 +16,9 @@ module Crunchbase
     SUPPORTED_ENTITIES = {
       'categories' => Model::Category,
       'organizations' => Model::OrganizationSummary,
+      'organization' => Model::Organization,
       'people' => Model::PersonSummary,
+      'person' => Model::Person,
       'products' => Model::ProductSummary,
       'ipos' => Model::Ipo,
       'funding_rounds' => Model::FundingRound,
@@ -83,6 +85,14 @@ module Crunchbase
         get_json_response(uri)
       end
 
+      # Fetches URI for the search interface and adapts the payload.
+      def batch_search(requests_array)
+        uri = "#{api_url}batch"
+        request_body = { requests: requests_array }
+
+        post_json_response(uri, request_body)
+      end
+
       # Fetches URI for the search interface.
       def list(options, resource_list)
         options[:page]  = 1 if options[:page].nil?
@@ -151,7 +161,7 @@ module Crunchbase
         http = Net::HTTP.new(uri.host, uri.port)
         http.use_ssl = true if uri.scheme == 'https'
         response = http.start do |h|
-          h.request Net::HTTP::Get.new(uri.request_uri)
+          h.request Net::HTTP::Get.new(uri.request_uri, {'User-Agent' => 'crunchbase-ruby-library'})
         end
 
         case response
@@ -164,6 +174,55 @@ module Crunchbase
         end
       end
 
+      # Gets specified URI, and the object for request's body, then parses the returned JSON. Raises Timeout error
+      #   if request time exceeds set limit. Raises Exception if returned
+      #   JSON contains an error.
+      def post_json_response(uri, request_body)
+        raise Exception, 'User key required, visit https://data.crunchbase.com/v3.1/docs' unless @key
+
+        body_string = request_body.to_json
+
+        resp = Timeout.timeout(@timeout_limit) do
+          post_url_following_redirects(uri, body_string, @redirect_limit)
+        end
+
+        response = parser.parse(resp)
+        raise Exception, message: response['message'], status: response['status'] unless response['message'].nil?
+
+        response['data']
+      end
+
+      # Performs actual HTTP requests, recursively if a redirect response is
+      # encountered. Will raise HTTP error if response is not 200, 404, or 3xx.
+      def post_url_following_redirects(uri_str, body_string, limit = 10)
+        raise Exception, 'HTTP redirect too deep' if limit.zero?
+
+        uri = URI.parse(URI.encode(uri_str))
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true if uri.scheme == 'https'
+
+        req = Net::HTTP::Post.new(uri.request_uri)
+        req.add_field('User-Agent', 'crunchbase-ruby-library')
+        req.add_field('Content-Type', 'application/json')
+        req.add_field('X-Cb-User-Key', @key)
+
+        req.body = body_string
+
+        response = http.start do |h|
+          h.request req
+        end
+
+        case response
+        when Net::HTTPSuccess, Net::HTTPNotFound, Net::HTTPInternalServerError
+          response.body
+        when Net::HTTPRedirection
+          post_url_following_redirects(response['location'], limit - 1)
+        else
+          response.error!
+        end
+      end
+
       def debugging(uri)
         return unless debug
 

data/lib/crunchbase/client.rb

@@ -42,6 +42,15 @@ module Crunchbase
       kclass(kclass_name).organization_lists(permalink)
     end
 
+    # Runs a batch search and returns matched results
+    # Params:
+    # +requests+:: An array of hashes with following attributes: { 'type': String, 'uuid': String, 'relationships': String[] }
+    def batch_search(requests)
+      return [] if requests.nil?
+
+      kclass('BatchSearch').batch_search(requests)
+    end
+
     private
     def kclass(kclass_name)
       Crunchbase::Model.const_get kclass_name

data/lib/crunchbase/model.rb

@@ -9,6 +9,7 @@ module Crunchbase
     autoload :Acquisition,                  'crunchbase/model/acquisition'
     autoload :Address,                      'crunchbase/model/address'
     autoload :AdvisoryRole,                 'crunchbase/model/advisory_role'
+    autoload :BatchSearch,                  'crunchbase/model/batch_search'
     autoload :BoardMembersAndAdvisor,       'crunchbase/model/board_members_and_advisor'
     autoload :Category,                     'crunchbase/model/category'
     autoload :Competitor,                   'crunchbase/model/competitor'

data/lib/crunchbase/model/batch_search.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Crunchbase
+	module Model
+		class BatchSearch < Entity
+			include Enumerable
+
+			attr_reader :results
+
+			alias items results
+
+			def initialize(json)
+				@results = []
+
+				populate_results(json)
+			end
+
+			def populate_results(json)
+				@results = []
+
+				@results = json['items'].map do |r|
+					next Error.new(r['error']) if r.key?('error')
+
+					kclass = kclass_name(r['type'])
+					kclass.new(r)
+				end
+			end
+
+			def self.batch_search(requests)
+				raise ConfigurationException, 'Invalid argument. Please pass in an array as an argument' unless requests.is_a?(Array)
+				raise InvalidRequestException, "Too many requests(#{requests.length}) in batch, max allowed 10" if requests.length > 10
+				raise MissingParamsException, 'Missing :type or :uuid parameter in some requests' if requests.any? { |request| !request.key?(:type) || !request.key?(:uuid) }
+				return [] if requests.empty?
+
+				BatchSearch.new API.batch_search(requests)
+			end
+
+			private
+
+			def kclass_name(model_name)
+				self.class.kclass_name(model_name.downcase)
+			end
+
+		end
+	end
+end

data/lib/crunchbase/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Crunchbase
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/crunchbase/client_spec.rb

@@ -21,5 +21,15 @@ module Crunchbase
         expect(facebook_data1.permalink).to eq('facebook')
       end
     end
+
+    context '#get batched data' do
+      let(:response) { client.batch_search([{ type: 'Organization', uuid: 'df6628127f970b439d3e12f64f504fbb' }]) }
+
+      it 'should return batch search data' do
+        expect(response).to be_an_instance_of(Crunchbase::Model::BatchSearch)
+        expect(response.results).to be_an_instance_of(Array)
+        expect(response.results).to be_present
+      end
+    end
   end
 end

data/spec/crunchbase/model/batch_search_spec.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Crunchbase::Model
+	RSpec.describe BatchSearch do
+
+		context 'perform invalid batch_search' do
+			it 'should raise ConfigurationException for non-array argument' do
+				expect { BatchSearch.batch_search({}) }.to raise_error Crunchbase::ConfigurationException
+			end
+
+			it 'should raise InvalidRequestException for too many requests' do
+				expect { BatchSearch.batch_search(Array.new(11)) }.to raise_error Crunchbase::InvalidRequestException
+			end
+
+			it 'should raise MissingParamsException for invalid array item (without type and uuid fields)' do
+				invalid_array_arguments = [
+					[{}],
+					[{ type: 'Organization' }],
+					[{ type: 'Organization', uuid: 'unique_id' }, {}],
+					[{ type: 'Organization', uuid: 'unique_id' }, { uuid: 'unique_id' }]
+				]
+
+				invalid_array_arguments.each do |invalid_argument|
+					expect { BatchSearch.batch_search(invalid_argument) }.to raise_error Crunchbase::MissingParamsException
+				end
+			end
+
+			it 'should return an empty array for empty array argument' do
+				results = BatchSearch.batch_search([])
+				expect(results).to be_empty
+			end
+
+			it 'should return an instance of Error for invalid uuid' do
+				invalid_request = [{ type: 'Organization', uuid: 'invalid_id' }]
+				results = BatchSearch.batch_search(invalid_request)
+
+				expect(results.results.first).to be_an_instance_of(Crunchbase::Model::Error)
+			end
+		end
+
+		context 'perform valid batch_search' do
+			let(:requests) {
+				[
+					{ type: 'Organization', uuid: 'df6628127f970b439d3e12f64f504fbb' },
+					{ type: 'Organization', uuid: '0ea85f0296e15c42feebb786ecab2939' },
+					{ type: 'Person', uuid: 'a01b8d46d31133337c34aa3ae9c03f22' }
+				]
+			}
+			let(:batch_search) { BatchSearch.batch_search(requests) }
+
+			it 'should return new instance of BatchSearch' do
+				expect(batch_search).to be_an_instance_of(BatchSearch)
+			end
+
+			it 'should return an array of results' do
+				results = batch_search.results
+				expect(results).to be_an_instance_of(Array)
+				expect(results).not_to be_empty
+			end
+
+			it 'should return an array of valid model objects' do
+				results = batch_search.results
+				expect(results[0]).to be_a(Crunchbase::Model::Organization)
+				expect(results[1]).to be_a(Crunchbase::Model::Organization)
+				expect(results[2]).to be_a(Crunchbase::Model::Person)
+			end
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase-ruby-library
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Encore Shao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/crunchbase/model/acquisition.rb
 - lib/crunchbase/model/address.rb
 - lib/crunchbase/model/advisory_role.rb
+- lib/crunchbase/model/batch_search.rb
 - lib/crunchbase/model/board_members_and_advisor.rb
 - lib/crunchbase/model/category.rb
 - lib/crunchbase/model/competitor.rb
@@ -195,6 +196,7 @@ files:
 - spec/crunchbase/data/people/facebook_founders.json
 - spec/crunchbase/data/people/mark-zuckerberg.json
 - spec/crunchbase/data/websites/facebook.json
+- spec/crunchbase/model/batch_search_spec.rb
 - spec/crunchbase/model/board_members_and_advisor_spec.rb
 - spec/crunchbase/model/category_spec.rb
 - spec/crunchbase/model/current_team_spec.rb
@@ -262,6 +264,7 @@ test_files:
 - spec/crunchbase/data/people/facebook_founders.json
 - spec/crunchbase/data/people/mark-zuckerberg.json
 - spec/crunchbase/data/websites/facebook.json
+- spec/crunchbase/model/batch_search_spec.rb
 - spec/crunchbase/model/board_members_and_advisor_spec.rb
 - spec/crunchbase/model/category_spec.rb
 - spec/crunchbase/model/current_team_spec.rb