crunchbase_v2 0.0.1

data/.gitignore

@@ -0,0 +1,25 @@
+*.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
+
+*.swp
+spec/apikey.yml

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 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.rdoc

@@ -0,0 +1,88 @@
+= Crunchbase API
+
+Ruby API wrapper for [Crunchbase API](https://developer.crunchbase.com/docs) version 2.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'crunchbase', github: 'encoreshao/crunchbase_v2'
+
+And then execute:
+
+    $ bundle
+
+== Usage Examples
+
+Config your user_key, debug somewhere like development.rb.
+
+  Crunchbase::API.key   = 'YOUR_API_KEY'
+  Crunchbase::API.debug = false
+
+=== Search
+
+Searching the Crunchbase is possible with the Search class, The Search will return a list consisting of objects of the SearchResult type.
+
+   s = Crunchbase::Search.search("facebook")
+   OR
+   s = Crunchbase::Search.search({ domain_name: 'facebook.com' }, 'organizations')
+   s.total_items || s.per_page || s.pages || s.current_page
+   all_results = s.results
+   all_results.each { |r| puts r.name }
+
+=== Organizations && RelationShip List Items
+
+Get information by the permalink, Example:
+
+    company = Crunchbase::Organization.get("facebook")
+    Relationship objects 
+    [ competitors customers founders funding_rounds ipos products sub_organizations ]
+    Friendly relationship objects
+    [ past_teams current_teams acquisitions offices headquarters categories investments primary_images images websites new_items board_members_and_advisors ]
+    company.competitors               Only return Top 8 items
+    company.competitors_total_items   Return competitors total items count
+    company.competitors.each do |e|
+      competitor = a.fetch
+      puts competitor.name
+    end
+    OR
+    company.websites
+
+If you want all competitors items, Please do: 
+
+    all_competitors = Competitor.lists_for_permalink(company.permalink)
+    all_competitors.per_page
+    all_competitors.current_page
+    all_competitors.size
+    all_competitors.results           Return all competitors items
+
+=== People
+    
+  person = Crunchbase::Person.get( permalink )
+
+  #<Crunchbase::Person:0x007fc95bca3880 @type_name="Person" ..... > 
+
+  people = Crunchbase::Person.list( page )
+
+  people.results
+ 
+  [#<Crunchbase::SearchResult:0x007fd16ae18b40 ...>, 
+  #<Crunchbase::SearchResult:0x007fd16ae18870 ...>, 
+  #<Crunchbase::SearchResult:0x007fd16ae185a0 ...>, 
+  #<Crunchbase::SearchResult:0x007fd16ae182f8 ...>
+  ......]
+
+
+=== How to use Location & Category .... 
+  
+Such as a Person
+    
+== Contributing
+
+Contributions are welcome. Note that in order to run the test suite, you need to
+include an API key in +spec/apikey.yml+. This file is ignored by git. An example
+file is provided for convenience.
+
+== Copyright
+
+Copyright © 2014-08 Encore Shao. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/crunchbase.gemspec

@@ -0,0 +1,24 @@
+# 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_v2"
+  spec.version       = Crunchbase::VERSION
+  spec.authors       = ["Encore Shao"]
+  spec.email         = ["encore@ekohe.com"]
+  spec.summary       = %q{ Wrapper for Crunchbase API version 2 }
+  spec.description   = %q{ Wrapper for Crunchbase API version 2 }
+  spec.homepage      = "https://github.com/encoreshao/crunchbase_v2"
+  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", "~> 2.10.0"
+end

data/lib/crunchbase.rb

@@ -0,0 +1,36 @@
+require "crunchbase/api"
+require "crunchbase/crunch_exception"
+require "crunchbase/cb_entity"
+require "crunchbase/location"
+require "crunchbase/category"
+require "crunchbase/acquisition"
+require "crunchbase/competitor"
+require "crunchbase/customer"
+require "crunchbase/funding_round"
+require "crunchbase/founder"
+require "crunchbase/headquarter"
+require "crunchbase/sub_organization"
+require "crunchbase/image"
+require "crunchbase/primary_image"
+require "crunchbase/investment"
+require "crunchbase/ipo"
+require "crunchbase/new_item"
+require "crunchbase/office"
+require "crunchbase/organization"
+require "crunchbase/past_team"
+require "crunchbase/current_team"
+require "crunchbase/person"
+require "crunchbase/product"
+require "crunchbase/relationship"
+require "crunchbase/search"
+require "crunchbase/search_result"
+require "crunchbase/website"
+require "crunchbase/board_members_and_advisor"
+require "crunchbase/version"
+
+
+module Crunchbase
+  class << self
+    # coding...
+  end
+end

data/lib/crunchbase/acquisition.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+# http://api.crunchbase.com/v/2/organization/facebook/acquisitions?user_key=key
+module Crunchbase
+  class Acquisition < CBEntity
+    RESOURCE_NAME = 'acquisition'
+    RESOURCE_LIST = 'acquisitions'
+
+    attr_reader :announced_on, :announced_on_trust_code, :price_currency_code, 
+                :permalink, :name, :payment_type, :price, :disposition_of_acquired, 
+                :acquisition_type, :acquisition_status, :price_usd, :created_at, :updated_at
+
+    attr_reader :acquirers, :acquirees, :new_items
+
+    attr_reader :acquirers_total_items, :acquirees_total_items, :new_items_total_items
+
+    def initialize(json)
+      @type_name              = json['type']
+      properties              = json['properties']
+      relationships           = json['relationships']
+
+      @announced_on             = properties['announced_on'] && DateTime.parse(properties['announced_on'])
+      @announced_on_trust_code  = properties['announced_on_trust_code']
+      @price_currency_code      = properties['price_currency_code']
+      @permalink                = properties['permalink']
+      @name                     = properties['name']
+      @payment_type             = properties['payment_type']
+      @price                    = properties['price']
+      @disposition_of_acquired  = properties['disposition_of_acquired']
+      @acquisition_type         = properties['acquisition_type']
+      @acquisition_status       = properties['acquisition_status']
+      @price_usd                = properties['price_usd']
+      @created_at               = Time.at(properties['created_at']).utc
+      @updated_at               = Time.at(properties['updated_at']).utc
+
+      @acquirers_list           = relationships['acquirer']
+      @acquirees_list           = relationships['acquiree']
+      @new_items_list           = relationships['news']
+    end
+
+    def acquirers
+      @acquirers ||= Relationship.array_from_list(@acquirers_list)
+    end
+
+    def acquirees
+      @acquirees ||= Relationship.array_from_list(@acquirees_list)
+    end
+
+    def new_items
+      @new_items ||= NewItem.array_from_list(@new_items_list)
+    end
+
+    def acquirers_total_items
+      @acquirers_total_items ||= Relationship.total_items_from_list(@acquirers_list)
+    end
+
+    def acquirees_total_items
+      @acquirees_total_items ||= Relationship.total_items_from_list(@acquirees_list)
+    end
+
+    def new_items_total_items
+      @new_items_total_items ||= NewItem.total_items_from_list(@new_items_list)
+    end
+  end
+
+end

data/lib/crunchbase/api.rb

@@ -0,0 +1,153 @@
+# -*- coding: utf-8 -*-
+require 'net/http'
+
+begin
+  require 'yajl'
+rescue LoadError
+  require 'json'
+end
+
+require 'timeout'
+
+module Crunchbase
+
+  class API
+    SUPPORTED_ENTITIES = ['organizations', 'organization', 'people', 'person', 'products', 'product', 'funding_rounds', 'funding-round', 'acquisition', 'ipo', 'fund-raise', 'locations', 'categories', 'offices', 'customers']
+
+    @timeout_limit  = 60
+    @redirect_limit = 2
+    @version        = '2'
+    @base_url       = 'http://api.crunchbase.com'
+    @site_url       = "http://www.crunchbase.com"
+    @image_url      = "http://images.crunchbase.com/"
+    @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
+    
+    def self.all(entity)
+      get_json_response( api_url + entity )
+    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)
+      uri = api_url + "#{object_name}/#{permalink}"
+
+      get_json_response(uri)
+    end
+    
+    # Fetches URI for the search interface.
+    def self.search(options, object_lists)
+      options[:page] = 1 if options[:page].nil?
+      options[:order] = ORDER_CREATED_AT_ASC if options[:order].nil?
+      
+      uri = api_url + "#{object_lists}?" + collect_parameters(options)
+
+      get_json_response(uri)
+    end
+    
+    
+    # Fetches URI for the search interface.
+    def self.list(options, object_lists)
+      options[:page]  = 1 if options[:page].nil?
+      model_name      = options.delete(:model_name)
+      
+      uri = api_url + "#{object_lists}?" + collect_parameters(options)
+
+      Search.new options, get_json_response(uri), SearchResult
+    end
+    
+    def self.collect_parameters(options)
+      require "cgi"
+
+      options.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join('&')
+    end
+
+    # Searches for a permalink in a particular category.
+    # Demo: http://api.crunchbase.com/v/2/organization/facebook/offices?user_key=key
+    def self.lists_for_permalink(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 + "organization/#{permalink}/#{category}?#{collect_parameters(options)}"
+
+      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 CrunchException if returned
+    # JSON contains an error.
+    def self.get_json_response(uri)
+      raise CrunchException, "User key required, visit http://developer.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 CrunchException, response["error"] if response.class == Hash && response["error"]
+
+      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 CrunchException, 'HTTP redirect too deep' if limit == 0
+
+      url = URI.parse(uri_str)
+
+      if self.debug
+        length = (uri_str.length + 10)
+        puts "*"*length
+        puts "***  #{url}  ***"
+        puts "*"*length
+      end
+
+      response = Net::HTTP.start(url.host, url.port) { |http| http.get(url.request_uri) }
+      case response
+        when Net::HTTPSuccess, Net::HTTPNotFound
+          response.body
+        when Net::HTTPRedirection
+          get_url_following_redirects(response['location'], limit - 1)
+        else
+          response.error!
+      end
+    end
+
+  end
+end

data/lib/crunchbase/board_members_and_advisor.rb

@@ -0,0 +1,23 @@
+# encode: utf-8
+
+# http://api.crunchbase.com/v/2/organization/facebook/board_members_and_advisors
+
+module Crunchbase
+  class BoardMembersAndAdvisor < CBEntity
+    RESOURCE_LIST = 'board_members_and_advisors'
+
+    attr_reader :type_name, :first_name, :last_name, :title, :started_on, :path, 
+                :created_at, :updated_at
+    
+    def initialize(json)
+      @type_name    = json['type']
+      @first_name   = json['first_name']
+      @last_name    = json['last_name']
+      @title        = json['title']
+      @path         = json['path']
+      @started_on   = json['started_on'] && DateTime.parse(json['started_on'])
+      @created_at   = Time.at(json['created_at']).utc
+      @updated_at   = Time.at(json['updated_at']).utc
+    end
+  end
+end