crunchbase 0.2.2 → 0.3.0

data/README.rdoc

@@ -9,12 +9,15 @@ use the {YAJL gem}[http://github.com/brianmario/yajl-ruby]; if not, it will
 fall back to the {JSON gem}[http://flori.github.com/json/]. Please ensure one
 of the two is installed.
 
+You will need to get an API key from {Crunchbase}[http://developer.crunchbase.com/]
+
 == Usage
 
 If you already know the permalink for a given entity, you can grab the entry
 with the +get+ method.
 
    require 'crunchbase'
+   Crunchbase::API.key = 'your crunchbase api key'
    steve = Crunchbase::Person.get("steve-jobs")
    facebook = Crunchbase::Company.get("facebook")    
    
@@ -66,6 +69,12 @@ list does not entail a delay every ten items. Of course, the list is enormous
 (the list of all companies returns over 84,500 entries as of this writing), so 
 it's little consolation.
 
+== 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 (c) 2011-12 Tyler Cunnion. This software is made available under the 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/crunchbase.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "crunchbase"
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tyler Cunnion"]
-  s.date = "2012-06-05"
+  s.date = "2012-10-26"
   s.email = "tyler.cunnion@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
     "lib/crunchbase/search.rb",
     "lib/crunchbase/search_result.rb",
     "lib/crunchbase/service_provider.rb",
+    "spec/apikey.example.yml",
     "spec/crunchbase/api_spec.rb",
     "spec/crunchbase/company_spec.rb",
     "spec/crunchbase/financial_organization_spec.rb",

data/lib/crunchbase.rb

@@ -17,5 +17,5 @@ require 'crunchbase/search_result'
 require 'crunchbase/crunch_exception'
 
 module Crunchbase
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/crunchbase/api.rb

@@ -20,8 +20,7 @@ module Crunchbase
     SUPPORTED_ENTITIES = ['person', 'company', 'financial-organization', 'product', 'service-provider']
     @timeout_limit = 60
     @redirect_limit = 2
-    
-    class << self; attr_accessor :timeout_limit, :redirect_limit end
+    class << self; attr_accessor :timeout_limit, :redirect_limit, :key end
     
     def self.single_entity(permalink, entity_name)
       raise CrunchException, "Unsupported Entity Type" unless SUPPORTED_ENTITIES.include?(entity_name)
@@ -69,6 +68,8 @@ module Crunchbase
     # if request time exceeds set limit. Raises CrunchException if returned
     # JSON contains an error.
     def self.get_json_response(uri)
+      raise CrunchException, "API key required, visit http://developer.crunchbase.com" unless @key
+      uri = uri + "#{uri.match('\?') ? "&" : "?"}api_key=#{@key}"
       resp = Timeout::timeout(@timeout_limit) {
         get_url_following_redirects(uri, @redirect_limit)
       }

data/spec/apikey.example.yml

@@ -0,0 +1 @@
+key: <your_key_goes_here>

data/spec/crunchbase/api_spec.rb

@@ -4,9 +4,16 @@ require 'net/http'
 module Crunchbase
   describe API do
 
+    it "should raise exception for missing API key" do
+      key = API.key
+      API.key = nil
+      expect { API.fetch('steve-jobs', 'person') }.to raise_error
+      API.key = key
+    end
+
     it "should remove control characters" do
       cargurus = File.open(File.join(File.dirname(__FILE__), "..", "fixtures", "cargurus.js")).read
-      API.should_receive(:get_url_following_redirects).with("http://api.crunchbase.com/v/1/company/cargurus.js", 2).and_return(cargurus)
+      API.should_receive(:get_url_following_redirects).with(/^http:\/\/api.crunchbase.com\/v\/1\/company\/cargurus.js/, 2).and_return(cargurus)
       lambda { API.single_entity("cargurus", "company") }.should_not raise_error
     end
     

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
 require 'rspec'
 require 'crunchbase'
-require 'date'
+require 'date'
+require 'yaml'
+
+key_yaml = YAML.load_file(File.join(File.dirname(__FILE__),'apikey.yml'))
+
+Crunchbase::API.key = key_yaml["key"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crunchbase
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -124,6 +124,7 @@ files:
 - lib/crunchbase/search.rb
 - lib/crunchbase/search_result.rb
 - lib/crunchbase/service_provider.rb
+- spec/apikey.example.yml
 - spec/crunchbase/api_spec.rb
 - spec/crunchbase/company_spec.rb
 - spec/crunchbase/financial_organization_spec.rb
@@ -151,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -58343890205146869
+      hash: 1391900359395549373
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: