crunchbase-ruby-library 0.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+spec/crunchbase.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crunchbase-ruby-library.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Encore Shao
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# Crunchbase
+
+Crunchbase API Version 3 - Ruby Library [CrunchBase Data Hub](http://data.crunchbase.com/v3).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crunchbase-ruby-library'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crunchbase-ruby-library
+    
+## Usage Examples
+
+Config your user_key, debug somewhere like development.rb, Recommended directory config/initializers/crunchbase.rb
+
+    require 'crunchbase'
+
+    Crunchbase::API.key   = 'user_key'
+    Crunchbase::API.debug = false
+
+## Search Organization OR Person
+
+Retrieve the way, Please use Search Class. The Search Will Return a list consisting of objects of the OrganizationSummary | PersonSummary type. Example:
+    
+    Query Orgnization
+
+    Method 1
+    response = Crunchbase::Model::Search.search({query: "Google"}, 'organizations')  
+
+    Method 2
+    response = Crunchbase::Model::Search.search({name: "Google"}, 'organizations')  
+
+    Method 3
+    response = Crunchbase::Model::Search.search({domain_name: "google.com"}, 'organizations')  
+
+    response.total_items || response.per_page || response.pages || response.current_page
+    response.results.each { |r| puts r.name }
+
+
+    Query Person
+
+    response = Crunchbase::Model::Search.search({query: "encore"}, 'people')  
+
+    response.results.each { |i| [i.first_name, i.last_name] }
+
+## Get Organization && RelationShips
+
+Get information by the permalink, Example:
+
+    response = Crunchbase::Model::Organization.get("facebook")
+
+    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 ]
+
+    response.founders
+    response.competitors_total_items
+    response.websites
+
+    NOTE: If you want all `past_team` `board_members_and_advisors` items, Please do:
+
+    # Methods
+
+    past_team = Crunchbase::Model::PastTeam.organization_lists("facebook")
+    past_team.results.collect { |p| [p.title, p.person.first_name] }
+
+    ....
+
+## Person
+
+Get information by the permalink, Example:
+
+    person = Crunchbase::Model::Person.get( permalink )
+
+    #<Crunchbase::Model::Person:0x007fc185215f68 @type_name="Person", @uuid="a578dcf9859ec8b52182e3aa3c383b13", ...>
+
+    people = Crunchbase::Model::Person.list( page )
+
+    people.results
+   
+    [ #<Crunchbase::Model::PersonSummary:...>, 
+    #<Crunchbase::Model::PersonSummary: ...>, 
+    #<Crunchbase::Model::PersonSummary: ...>, 
+    #<Crunchbase::Model::PersonSummary: ...>
+    ...... ]
+
+## Contributing
+
+1. Fork it ( https://github.com/encoreshao/crunchbase-ruby-library/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Copyright
+
+Copyright © 2015-05 Encore Shao. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/crunchbase-ruby-library.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crunchbase/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crunchbase-ruby-library"
+  spec.version       = Crunchbase::VERSION
+  spec.authors       = ["Encore Shao"]
+  spec.email         = ["encore.shao@gmail.com"]
+  spec.summary       = %q{ Ruby wrapper for Crunchbase API version 3 }
+  spec.description   = %q{ Ruby wrapper for Crunchbase API version 3 }
+  spec.homepage      = "https://github.com/encoreshao/crunchbase-ruby-library"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+end

data/lib/crunchbase.rb

@@ -0,0 +1,12 @@
+require 'singleton'
+require 'time'
+
+require "crunchbase/version"
+require 'crunchbase/api'
+require 'crunchbase/model'
+require "crunchbase/exception"
+
+module Crunchbase
+  class << self
+  end
+end

data/lib/crunchbase/api.rb

@@ -0,0 +1,160 @@
+# encoding: utf-8
+
+require 'net/http'
+
+begin
+  require 'yajl'
+rescue LoadError
+  require 'json'
+end
+
+require 'timeout'
+
+module Crunchbase
+  class API
+
+    SUPPORTED_ENTITIES = ['organizations', 'people', 'products', 'funding_rounds', 'acquisitions', 'ipos', 'locations', 'categories', 'offices', 'customers', 'degrees', 'experience', 'primary_affiliation', 'videos', 'founded_companies', 'primary_location', 'advisor_at']
+
+    @timeout_limit  = 60
+    @redirect_limit = 2
+    @version        = '3'
+    @base_url       = 'https://api.crunchbase.com'
+    @site_url       = "https://www.crunchbase.com"
+    @image_url      = "https://res.cloudinary.com/crunchbase-production/"
+    @debug          = false
+
+    # Must be overridden in subclasses
+    RESOURCE_NAME         = "undefined"
+    RESOURCE_LIST         = "undefineds"
+
+    ORDER_CREATED_AT_ASC  = 'created_at asc'
+    ORDER_CREATED_AT_DESC = 'created_at desc'
+    ORDER_UPDATED_AT_ASC  = 'updated_at asc'
+    ORDER_UPDATED_AT_DESC = 'updated_at desc'
+
+    class << self
+      attr_accessor :timeout_limit, :redirect_limit, :key, :base_url, :version, :debug, :image_url, :site_url
+
+      def api_url
+        base_url.gsub(/\/$/, '') + '/v/' + version + '/'
+      end
+    end
+
+    def self.single_entity(permalink, entity_name)
+      raise CrunchException, "Unsupported Entity Type" unless SUPPORTED_ENTITIES.include?(entity_name)
+
+      fetch(permalink, entity_name)
+    end
+
+    private
+    
+    # Returns the JSON parser, whether that's an instance of Yajl or JSON
+    def self.parser
+      if defined?(Yajl)
+        Yajl::Parser
+      else
+        JSON
+      end
+    end
+
+    # Fetches URI for the permalink interface.
+    def self.fetch(permalink, object_name)
+      get_json_response( api_url + "#{object_name}/#{permalink}" )
+    end
+    
+    # Fetches URI for the search interface.
+    def self.search(options, resource_list)
+      options[:page] = 1 if options[:page].nil?
+      options[:order] = ORDER_CREATED_AT_ASC if options[:order].nil?
+      
+      uri = api_url + "#{resource_list}?" + collect_parameters(options)
+
+      get_json_response(uri)
+    end
+    
+    
+    # Fetches URI for the search interface.
+    def self.list(options, resource_list)
+      options[:page]  = 1 if options[:page].nil?
+      model_name      = options.delete(:model_name)
+      
+      uri = api_url + "#{resource_list}?" + collect_parameters(options)
+
+      Crunchbase::Model::Search.new options, get_json_response(uri), model_name
+    end
+    
+    def self.collect_parameters(options)
+      require "cgi"
+
+      options.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join('&')
+    end
+
+    def self.organization_lists(permalink, category, options)
+      lists_for_category('organizations', permalink, category, options)
+    end
+
+    # Demo: https://api.crunchbase.com/v/#{version}/person/#{person-permalink}/offices?user_key=key
+    def self.person_lists(permalink, category, options)
+      lists_for_category('people', permalink, category, options)
+    end
+
+    def self.lists_for_category(classify_name, permalink, category, options)
+      options[:page]  = 1 if options[:page].nil?
+      options[:order] = ORDER_CREATED_AT_ASC if options[:order].nil?
+      model_name      = options.delete(:model_name)
+
+      uri = api_url + "#{classify_name}/#{permalink}/#{category}?#{collect_parameters(options)}"
+
+      Crunchbase::Model::Search.new options, get_json_response(uri), model_name
+    end
+    
+    # Gets specified URI, then parses the returned JSON. Raises Timeout error 
+    # if request time exceeds set limit. Raises Crunchbase::Exception if returned
+    # JSON contains an error.
+    def self.get_json_response(uri)
+      raise Crunchbase::Exception, "User key required, visit http://data.crunchbase.com" unless @key
+      uri = uri + "#{uri.match('\?') ? "&" : "?"}user_key=#{@key}"
+
+      resp = Timeout::timeout(@timeout_limit) {
+        get_url_following_redirects(uri, @redirect_limit)
+      }
+      response = parser.parse(resp)["data"]
+
+      raise Crunchbase::Exception, response["error"] if response.class == Hash && response["error"] && response["error"]["code"] != 500
+
+      response
+    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 self.get_url_following_redirects(uri_str, limit = 10)
+      raise Crunchbase::Exception, 'HTTP redirect too deep' if limit == 0
+
+      uri = URI.parse(uri_str)
+
+      debug_log!(uri) if debug
+
+      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)
+      end
+
+      case response
+        when Net::HTTPSuccess, Net::HTTPNotFound, Net::HTTPInternalServerError
+          response.body
+        when Net::HTTPRedirection
+          get_url_following_redirects(response['location'], limit - 1)
+        else
+          response.error!
+      end
+    end
+
+    def self.debug_log!(uri)
+      puts "*"*120
+      puts "***  #{uri}  ***"
+      puts "*"*120
+    end
+
+  end
+end

data/lib/crunchbase/exception.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Crunchbase
+  class Exception < ::Exception
+  end
+
+  class ConfigurationException < Exception
+  end
+
+  class MissingParamsException < Exception
+  end
+
+  class InvalidRequestException < Exception
+  end
+
+  class ResponseTypeException < Exception
+  end
+end

data/lib/crunchbase/model.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Crunchbase
+  module Model
+    autoload :AcquiredBy,                   "crunchbase/model/acquired_by"
+    autoload :Acquisition,                  "crunchbase/model/acquisition"
+    autoload :Address,                      "crunchbase/model/address"
+    autoload :AdvisoryRole,                 "crunchbase/model/advisory_role"
+    autoload :BoardMembersAndAdvisor,       "crunchbase/model/board_members_and_advisor"
+    autoload :Category,                     "crunchbase/model/category"
+    autoload :Competitor,                   "crunchbase/model/competitor"
+    autoload :CurrentTeam,                  "crunchbase/model/current_team"
+    autoload :Customer,                     "crunchbase/model/customer"
+    autoload :Degree,                       "crunchbase/model/degree"
+    autoload :Error,                        "crunchbase/model/error"
+    autoload :Entity,                       "crunchbase/model/entity"
+    autoload :FoundedCompany,               "crunchbase/model/founded_company"
+    autoload :Founder,                      "crunchbase/model/founder"
+    autoload :Fund,                         "crunchbase/model/fund"
+    autoload :FundingRound,                 "crunchbase/model/funding_round"
+    autoload :Headquarter,                  "crunchbase/model/headquarter"
+    autoload :Image,                        "crunchbase/model/image"
+    autoload :Investment,                   "crunchbase/model/investment"
+    autoload :Investor,                     "crunchbase/model/investor"
+    autoload :Ipo,                          "crunchbase/model/ipo"
+    autoload :Job,                          "crunchbase/model/job"
+    autoload :Location,                     "crunchbase/model/location"
+    autoload :Member,                       "crunchbase/model/member"
+    autoload :Membership,                   "crunchbase/model/membership"
+    autoload :New,                          "crunchbase/model/new"
+    autoload :Office,                       "crunchbase/model/office"
+    autoload :Organization,                 "crunchbase/model/organization"
+    autoload :OrganizationSummary,          "crunchbase/model/organization_summary"
+    autoload :OwnedBy,                      "crunchbase/model/owned_by"
+    autoload :PastTeam,                     "crunchbase/model/past_team"
+    autoload :Person,                       "crunchbase/model/person"
+    autoload :PersonSummary,                "crunchbase/model/person_summary"
+    autoload :PrimaryAffiliation,           "crunchbase/model/primary_affiliation"
+    autoload :PrimaryImage,                 "crunchbase/model/primary_image"
+    autoload :PrimaryLocation,              "crunchbase/model/primary_location"
+    autoload :Product,                      "crunchbase/model/product"
+    autoload :School,                       "crunchbase/model/school"
+    autoload :Search,                       "crunchbase/model/search"
+    autoload :SearchResult,                 "crunchbase/model/search_result"
+    autoload :SubOrganization,              "crunchbase/model/sub_organization"
+    autoload :Video,                        "crunchbase/model/video"
+    autoload :Website,                      "crunchbase/model/website"
+  end
+end

data/lib/crunchbase/model/acquired_by.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module Crunchbase::Model
+  class AcquiredBy < Crunchbase::Model::Acquisition
+    RESOURCE_LIST = 'acquired_by'
+  end
+end

data/lib/crunchbase/model/acquisition.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Crunchbase::Model
+  class Acquisition < Crunchbase::Model::Entity
+    
+    RESOURCE_LIST = 'acquisitions'
+
+    attr_reader :api_path, :web_path, :price, :price_currency_code, :price_usd, 
+                :payment_type, :acquisition_type, :acquisition_status, :disposition_of_acquired, 
+                :announced_on, :announced_on_trust_code, :completed_on, :completed_on_trust_code, 
+                :created_at, :updated_at
+
+
+    attr_reader :acquirer, :acquiree
+
+    attr_reader :acquirer_total_items, :acquiree_total_items
+
+    def initialize(json)
+      super
+
+      unless (relationships = json['relationships']).nil?
+        instance_relationships_object(Crunchbase::Model::Organization, 'acquiree', relationships['acquiree'])
+      end
+    end
+
+    def property_keys
+      %w[
+        api_path web_path price price_currency_code price_usd 
+        payment_type acquisition_type acquisition_status disposition_of_acquired 
+        announced_on announced_on_trust_code completed_on completed_on_trust_code 
+        created_at updated_at
+      ]
+    end
+
+  end
+end