crunchbase 0.1.0 → 0.2.0

data/README.rdoc

@@ -49,7 +49,19 @@ number of results.
    all_results = s.to_ary
    result_slice = s[3..6]
 
-Coming Soon: List of Entities
+=== List all Items
+
+If you've gone insane and want a list of every single item for a given entity
+type, you can do so with the +all+ method.
+
+    all_companies = Company.all
+    company = all_companies[105]
+    
+This returns an array containing objects representing each entity. Just like 
+Search, the full item can be grabbed with the +entity+ method. Unlike Search,
+however, all of the items are pre-fetched, so iterating through the list does
+not entail a delay every ten items. Of course, the list is probably enormous,
+so it's little consolation.
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/crunchbase.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{crunchbase}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Tyler Cunnion}]
-  s.date = %q{2012-02-21}
+  s.date = %q{2012-02-28}
   s.email = %q{tyler.cunnion@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/crunchbase/company.rb",
     "lib/crunchbase/crunch_exception.rb",
     "lib/crunchbase/date_methods.rb",
+    "lib/crunchbase/entity_list_item.rb",
     "lib/crunchbase/financial_organization.rb",
     "lib/crunchbase/investment.rb",
     "lib/crunchbase/person.rb",

data/lib/crunchbase.rb

@@ -11,10 +11,11 @@ require 'crunchbase/relationship'
 require 'crunchbase/relationships/firm_relationship'
 require 'crunchbase/relationships/person_relationship'
 require 'crunchbase/relationships/provider_relationship'
+require 'crunchbase/entity_list_item'
 require 'crunchbase/search'
 require 'crunchbase/search_result'
 require 'crunchbase/crunch_exception'
 
 module Crunchbase
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/crunchbase/api.rb

@@ -17,31 +17,22 @@ module Crunchbase
   # methods provided on each entity class instead of calling these directly.
   class API
     CB_URL = 'http://api.crunchbase.com/v/1/'
+    SUPPORTED_ENTITIES = ['person', 'company', 'financial-organization', 'product', 'service-provider']
     @timeout_limit = 60
     @redirect_limit = 2
     
     class << self; attr_accessor :timeout_limit, :redirect_limit end
-
-    def self.person(permalink)
-      fetch(permalink, 'person')
-    end
-
-    def self.company(permalink)
-      fetch(permalink, 'company')
-    end
-
-    def self.financial_organization(permalink)
-      fetch(permalink, 'financial-organization')
-    end
-
-    def self.product(permalink)
-      fetch(permalink, 'product')
+    
+    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.service_provider(permalink)
-      fetch(permalink, 'service-provider')
+    
+    def self.all(entity)
+      uri = CB_URL + entity + ".js"
+      get_json_response(uri)
     end
-
+    
     private
     
     # Returns the JSON parser, whether that's an instance of Yajl or JSON
@@ -82,7 +73,7 @@ module Crunchbase
         get_url_following_redirects(uri, @redirect_limit)
       }
       j = parser.parse(resp)
-      raise CrunchException, j["error"] if j["error"]
+      raise CrunchException, j["error"] if j.class == Hash && j["error"]
       j
     end
 

data/lib/crunchbase/cb_object.rb

@@ -2,7 +2,11 @@ module Crunchbase
   
   # Represents any object which can be pulled directly from the CB API.
   class CB_Object
-
+    
+    # Must be overridden in subclasses
+    ENT_NAME = "undefined"
+    ENT_PLURAL = "undefineds"
+    
     # Returns an array of tags
     def tags
       @tag_list.respond_to?('split') ? @tag_list.split(', ') : []
@@ -13,6 +17,24 @@ module Crunchbase
       @alias_list.respond_to?('split') ? @alias_list.split(", ") : []
     end
     
+    # Factory method to return an instance from a permalink  
+    def self.get(permalink)
+      j = API.single_entity(permalink, self::ENT_NAME)
+      e = self.new(j)
+      return e
+    end
+    
+    def self.find(name)
+      get(API.permalink({name: name}, self::ENT_PLURAL)["permalink"])
+    end
+    
+    def self.all
+      all = API.all(self::ENT_PLURAL).map do |ent|
+        ent["namespace"] = self::ENT_NAME
+        EntityListItem.new(ent)
+      end
+    end
+    
     
     # Compares two objects, returning true if they have the same permalink
     # (ie, represent the same entity). If you must ensure that the two objects

data/lib/crunchbase/company.rb

@@ -3,6 +3,9 @@ module Crunchbase
   # Represents a Company listed in the Crunchbase.
   class Company < CB_Object
     
+    ENT_NAME = "company"
+    ENT_PLURAL = "companies"
+    
     include Crunchbase::DateMethods
     
     attr_reader :name, :permalink, :crunchbase_url, :homepage_url, :blog_url,
@@ -13,18 +16,6 @@ module Crunchbase
       :investments, :acquisition, :acquisitions, :offices, :milestones, :ipo, 
       :video_embeds, :screenshots, :external_links
     
-    # Factory method to return a Company instance from a permalink  
-    def self.get(permalink)
-      j = API.company(permalink)
-      c = Company.new(j)
-      return c
-    end
-
-    # Factory method to return a Company instance from a company name.
-    def self.find(name)
-      get(API.permalink({name: name}, "companies")["permalink"])
-    end
-    
     def initialize(json)
       @name = json["name"]
       @permalink = json["permalink"]

data/lib/crunchbase/entity_list_item.rb

@@ -0,0 +1,59 @@
+module Crunchbase
+  class EntityListItem
+    
+    attr_reader :permalink, :namespace
+    
+    def initialize(json)
+      @namespace = json["namespace"]
+      if @namespace == "person"
+        @first_name = json["first_name"]
+        @last_name = json["last_name"]
+      else
+        @name = json["name"]
+      end
+      @permalink = json["permalink"]
+    end
+    
+    def first_name
+      raise CrunchException, "Not available for this entity" unless namespace == "person"
+      @first_name
+    end
+    
+    def last_name
+      raise CrunchException, "Not available for this entity" unless namespace == "person"
+      @last_name
+    end
+    
+    # Returns concatenation of first and last names if person, otherwise
+    # returns name. Thus, if you wanted to, for example, iterate over search
+    # results and output the name, you could do so without checking entity type
+    # first.
+    def name
+      if @namespace == "person"
+        @first_name + " " + @last_name
+      else
+        @name
+      end
+    end
+
+    # Returns the entity associated with the search result, loading from
+    # memory if previously fetched, unless +force_reload+ is set to true.
+    def entity(force_reload=false)
+      return @entity unless @entity.nil? || force_reload
+      @entity = case @namespace
+      when "company"
+        Company.get(@permalink)
+      when "financial-organization"
+        FinancialOrganization.get(@permalink)
+      when "person"
+        Person.get(@permalink)
+      when "product"
+        Product.get(@permalink)
+      when "service-provider"
+        ServiceProvider.get(@permalink)
+      end
+      return @entity
+    end
+      
+  end
+end

data/lib/crunchbase/financial_organization.rb

@@ -3,6 +3,9 @@ module Crunchbase
   # Represents a Financial Organization listed in the Crunchbase.
   class FinancialOrganization < CB_Object
     
+    ENT_NAME = "financial-organization"
+    ENT_PLURAL = "financial-organizations"
+    
     include Crunchbase::DateMethods
     
     attr_reader :name, :permalink, :crunchbase_url, :homepage_url, :blog_url,
@@ -11,17 +14,6 @@ module Crunchbase
       :overview, :image, :offices, :relationships, :investments, :milestones, 
       :providerships, :funds, :video_embeds, :external_links
     
-    # Factory method to return a FinancialOrganization instance from a permalink
-    def self.get(permalink)
-      j = API.financial_organization(permalink)
-      f = FinancialOrganization.new(j)
-      return f
-    end
-
-    def self.find(name)
-      get(API.permalink({name: name}, "financial-organizations")["permalink"])
-    end
-    
     def initialize(json)
       @name = json['name']
       @permalink = json['permalink']

data/lib/crunchbase/person.rb

@@ -2,6 +2,9 @@ require 'date'
 module Crunchbase
   class Person < CB_Object
     
+    ENT_NAME = "person"
+    ENT_PLURAL = "people"
+    
     include Crunchbase::DateMethods
             
     attr_reader :first_name, :last_name, :permalink, :crunchbase_url,
@@ -9,13 +12,6 @@ module Crunchbase
       :affiliation_name, :created_at, :updated_at, :overview, :created_at, 
       :updated_at, :overview, :relationships, :investments, :milestones, 
       :video_embeds, :external_links, :web_presences
-    
-    # Factory method to return a Person instance from a permalink
-    def self.get(permalink)
-      j = API.person(permalink)
-      p = Person.new(j)
-      return p
-    end
 
     def self.find(first_name, last_name)
       get(API.permalink({first_name: first_name, last_name: last_name}, "people")["permalink"])

data/lib/crunchbase/product.rb

@@ -2,6 +2,9 @@ require 'date'
 module Crunchbase
   class Product < CB_Object
     
+    ENT_NAME = "product"
+    ENT_PLURAL = "products"
+    
     include Crunchbase::DateMethods
     
     attr_reader :name, :permalink, :crunchbase_url, :homepage_url, :blog_url,
@@ -9,15 +12,6 @@ module Crunchbase
       :invite_share_url, :created_at, :updated_at, :overview, :image, 
       :company_permalink, :company_name, :milestones, :video_embeds, 
       :external_links
-      
-    def self.get(permalink)
-      j = API.product(permalink)
-      return Product.new(j)
-    end
-
-    def self.find(name)
-      get(API.permalink({name: name}, "products")["permalink"])
-    end
     
     def initialize(json)
       @name = json['name']

data/lib/crunchbase/search_result.rb

@@ -3,61 +3,14 @@ module Crunchbase
   # returned from a search includes the name, namespace (i.e. entity type),
   # permalink, and an overview. You may also choose to retrieve the full
   # entity with the entity method.  
-  class SearchResult
-    attr_reader :permalink, :crunchbase_url, :namespace, :overview
-    
-    def first_name
-      raise CrunchException, "Not available for this entity" unless namespace == "person"
-      @first_name
-    end
-    
-    def last_name
-      raise CrunchException, "Not available for this entity" unless namespace == "person"
-      @last_name
-    end
-    
-    # Returns concatenation of first and last names if person, otherwise
-    # returns name. Thus, if you wanted to, for example, iterate over search
-    # results and output the name, you could do so without checking entity type
-    # first.
-    def name
-      if @namespace == "person"
-        @first_name + " " + @last_name
-      else
-        @name
-      end
-    end
+  class SearchResult < EntityListItem
+    attr_reader :crunchbase_url, :overview
     
     def initialize(json)
-      @namespace = json["namespace"]
-      if @namespace == "person"
-        @first_name = json["first_name"]
-        @last_name = json["last_name"]
-      else
-        @name = json["name"]
-      end
-      @permalink = json["permalink"]
+      super
       @crunchbase_url = json["crunchbase_url"]
       @overview = json["overview"]
     end
-    
-    # Returns the entity associated with the search result, loading from
-    # memory if previously fetched, unless +force_reload+ is set to true.
-    def entity(force_reload=false)
-      return @entity unless @entity.nil? || force_reload
-      @entity = case @namespace
-      when "company"
-        Company.get(@permalink)
-      when "financial-organization"
-        FinancialOrganization.get(@permalink)
-      when "person"
-        Person.get(@permalink)
-      when "product"
-        Product.get(@permalink)
-      when "service-provider"
-        ServiceProvider.get(@permalink)
-      end
-      return @entity
-    end
+
   end
 end

data/lib/crunchbase/service_provider.rb

@@ -2,20 +2,12 @@ require 'date'
 module Crunchbase
   class ServiceProvider < CB_Object
     
+    ENT_NAME = "service-provider"
+    ENT_PLURAL = "service-providers"
+    
     attr_reader :name, :permalink, :crunchbase_url, :homepage_url, 
     :phone_number, :created_at, :updated_at, :overview, :image, :offices,
     :providerships, :external_links
-
-    # Factory method to return a ServiceProvider instance from a permalink      
-    def self.get(permalink)
-      j = API.service_provider(permalink)
-      s = ServiceProvider.new(j)
-      return s
-    end
-
-    def self.find(name)
-      get(API.permalink({name: name}, "service-providers")["permalink"])
-    end
     
     def initialize(json)
       @name = json["name"]

data/spec/crunchbase/api_spec.rb

@@ -10,12 +10,16 @@ module Crunchbase
     end
     
     it "should return JSON from person permalink" do
-      j = API.person("steve-jobs")
+      j = API.single_entity("steve-jobs", "person")
       j.class.should == Hash
     end
     
     it "should raise exception on unfound person" do
-      expect { API.person("not-real") }.to raise_error
+      expect { API.single_entity("not-real", "person") }.to raise_error, "Sorry, we could not find the record you were looking for."
+    end
+    
+    it "should raise exception for incorrect entity name" do
+      expect { API.single_entity("whatever", "wrong") }.to raise_error, "Unsupported Entity Type"
     end
     
     it "should follow redirects" do

data/spec/crunchbase/company_spec.rb

@@ -26,6 +26,11 @@ module Crunchbase
         "updated_at" => "Sat Dec 22 08:42:28 UTC 2007"})
       company.deadpooled.should === Date.new(2004, 2, 1)
     end
+    
+    it "should get a complete list" do
+      all_companies = Company.all
+      all_companies[0].entity.name.should == all_companies[0].name
+    end
       
     
   end

data/spec/crunchbase/financial_organization_spec.rb

@@ -20,5 +20,10 @@ module Crunchbase
       finorg.founded.should === Date.new(2004, 2, 1)
     end
     
+    it "should get a complete list" do
+      all_fins = FinancialOrganization.all
+      all_fins[0].entity.name.should == all_fins[0].name
+    end
+    
   end
 end

data/spec/crunchbase/person_spec.rb

@@ -15,16 +15,16 @@ module Crunchbase
     end 
     
     it "should ask for JSON object" do
-      API.should_receive(:person).with("brad-fitzpatrick").and_return(JSON.parse(@brad.read))
+      API.should_receive(:single_entity).with("brad-fitzpatrick", "person").and_return(JSON.parse(@brad.read))
       person = Person.get("brad-fitzpatrick")
     end
     
     it "should get information from supplied file" do
-      API.should_receive(:person).with("steve-jobs").and_return(JSON.parse(@steve.read))
+      API.should_receive(:single_entity).with("steve-jobs", "person").and_return(JSON.parse(@steve.read))
       person = Person.get("steve-jobs")
       person.first_name.should == "Steve"
       
-      API.should_receive(:person).with("brad-fitzpatrick").and_return(JSON.parse(@brad.read))
+      API.should_receive(:single_entity).with("brad-fitzpatrick", "person").and_return(JSON.parse(@brad.read))
       person = Person.get("brad-fitzpatrick")
       person.first_name.should == "Brad"
     end
@@ -72,5 +72,11 @@ module Crunchbase
       person.should === person2
     end
     
+    it "should get a complete list" do
+      all_people = Person.all
+      all_people[0].entity.first_name.should == all_people[0].first_name
+      all_people[0].entity.last_name.should == all_people[0].last_name
+    end
+    
   end
 end

data/spec/crunchbase/product_spec.rb

@@ -26,5 +26,10 @@ module Crunchbase
         "updated_at" => "Sat Dec 22 08:42:28 UTC 2007", "company" => {}})
       product.deadpooled.should === Date.new(2004, 2, 1)
     end
+    
+    it "should get a complete list" do
+      all_products = Product.all
+      all_products[0].entity.name.should == all_products[0].name
+    end
   end
 end

data/spec/crunchbase/service_provider_spec.rb

@@ -13,5 +13,10 @@ module Crunchbase
       sp.permalink.should == "fox-rothschild"
     end
     
+    it "should get a complete list" do
+      all_sps = ServiceProvider.all
+      all_sps[0].entity.name.should == all_sps[0].name
+    end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-21 00:00:00.000000000Z
+date: 2012-02-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70265569207100 !ruby/object:Gem::Requirement
+  requirement: &70327968354500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265569207100
+  version_requirements: *70327968354500
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70265569206160 !ruby/object:Gem::Requirement
+  requirement: &70327968353340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70265569206160
+  version_requirements: *70327968353340
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70265569205140 !ruby/object:Gem::Requirement
+  requirement: &70327968352400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70265569205140
+  version_requirements: *70327968352400
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70265569204040 !ruby/object:Gem::Requirement
+  requirement: &70327968350960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265569204040
+  version_requirements: *70327968350960
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70265569202940 !ruby/object:Gem::Requirement
+  requirement: &70327968349800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265569202940
+  version_requirements: *70327968349800
 description: 
 email: tyler.cunnion@gmail.com
 executables: []
@@ -87,6 +87,7 @@ files:
 - lib/crunchbase/company.rb
 - lib/crunchbase/crunch_exception.rb
 - lib/crunchbase/date_methods.rb
+- lib/crunchbase/entity_list_item.rb
 - lib/crunchbase/financial_organization.rb
 - lib/crunchbase/investment.rb
 - lib/crunchbase/person.rb
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4487821890368483707
+      hash: 2248363577786522930
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: