startupstats 0.0.5 → 0.0.6

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 coverage/*
 .idea
 .DS_Store
+spec/vcr

data/.rvmrc

@@ -6,7 +6,7 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
 # Only full ruby name is supported here, for short names use:
 #     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p194@startupstats-client"
+environment_id="ruby-1.9.3-p327@startupstats-client"
 
 # Uncomment the following lines if you want to verify rvm version per project
 # rvmrc_rvm_version="1.14.12 ()" # 1.10.1 seams as a safe start

data/lib/startupstats.rb

@@ -1,6 +1,7 @@
 require "startupstats/version"
 require "startupstats/configurable"
 require "startupstats/formd/client"
+require "startupstats/countdb/client"
 #Dir[File.dirname(__FILE__) + '/startupstats/formd/*'].each {|file| require file }
 
 module StartupStats
@@ -28,4 +29,27 @@ module StartupStats
 		end
 	end
 
+	module Countdb
+		class << self
+			include StartupStats::Configurable
+
+	    	# Delegate to a StartupStats::Countdb::Client
+			#
+			# @return [StartupStats::Countdb::Client]
+			def client
+				@client = StartupStats::Countdb::Client.new(options) unless defined?(@client) && @client.cache_key == options.hash
+				@client
+			end
+
+			def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+			def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+		private
+			def method_missing(method_name, *args, &block)
+				return super unless client.respond_to?(method_name)
+				client.send(method_name, *args, &block)
+			end
+		end
+	end
+
 end

data/lib/startupstats/configurable.rb

@@ -1,8 +1,8 @@
 require 'startupstats/default'
 module StartupStats
   module Configurable
-    attr_writer :access_token, :access_token_key
-    attr_accessor :endpoint, :connection_options, :middleware
+    attr_writer :access_token
+    attr_accessor :endpoint, :connection_options, :middleware, :access_token_key
 
     class << self
 

data/lib/startupstats/countdb/client.rb

@@ -0,0 +1,30 @@
+require 'startupstats/configurable'
+require 'startupstats/requestable'
+require 'startupstats/countdb/counts'
+require 'startupstats/error/client_error'
+require 'startupstats/error/decode_error'
+require 'startupstats/error/params_error'
+
+module StartupStats
+	module Countdb
+		class Client #< StartupStats::Client
+			attr_accessor :db_id
+			# StartupStats client modules
+			include StartupStats::Configurable
+			include StartupStats::Requestable
+
+			# Countdb modules
+			include StartupStats::Countdb::Counts
+
+			def initialize( options = {} )
+				# raise StartupStats::Error::ParamsError unless options.has_key?(:db_id) && options[:db_id].match(/^\w+$/)
+				@db_id = ( options.has_key?(:db_id) ) ? options[:db_id] : nil
+				setup
+				@access_token_key = 'token'
+				StartupStats::Configurable.keys.each do |key|
+					instance_variable_set(:"@#{key}", options[key] || instance_variable_get(:"@#{key}"))
+				end
+			end
+		end
+	end
+end

data/lib/startupstats/countdb/counts.rb

@@ -0,0 +1,92 @@
+require 'startupstats/countdb/models/count'
+require 'startupstats/response/api_result'
+module StartupStats
+	module Countdb
+		module Counts
+			# Increments the value for a key
+			# 
+			# @raise [StartupStats::Error::ParamsError] Error raised when inaccurate values 
+			# @param key [String]
+			# @param count [Integer]
+			# @return [Boolean] Whether or not the request was successful
+			def increment_key( key , count )
+				raise StartupStats::Error::ParamsError unless key.to_s =~ /^[^\s]+$/ && count.to_s =~ /^\d+$/ && @db_id
+				res = send(:post , 'counts' , { 'key' => key , 'count' => count , 'db_id' => @db_id } )
+				( res[:status] == 200 )
+			end
+
+			# Increments the key for a specific date
+			# 
+			# @raise [StartupStats::Error::ParamsError] Error raised when inaccurate values 
+			# @param key [String]
+			# @param count [Integer]
+			# @param date [Integer]
+			# @return [Boolean] Whether or not the request was successful
+			def increment_key_for_date( key , count , date )
+				raise StartupStats::Error::ParamsError unless key.to_s =~ /^[^\s]+$/ && count.to_s =~ /^\d+$/ && date.to_s =~ /^\d+$/ && @db_id
+				res = send(:post , 'counts' , { 'key' => key , 'count' => count , 'db_id' => @db_id , 'date' => date } )
+				( res[:status] == 200 )
+			end
+
+			# Returns all the counts for a key
+			# 
+			# @raise [StartupStats::Error::ParamsError]
+			# @param key [String]
+			# @return [StartupStats::ApiResult] 
+			def counts_for_key( key )
+				res = send( :get , "counts/#{key}" , { 'db_id' => @db_id } )
+				# parse the counts
+				counts = []
+				res[:body][:counts].each{ |count|
+					c = StartupStats::Countdb::Count.new
+					c.key = key 
+					c.db_id = @db_id
+					c.count = count[:count]
+					c.date = count[:date]
+					counts.push( c )
+				}
+				StartupStats::ApiResult.new( { 'total_count' => counts.length , 'start' => 0 , 'limit' => 0 , 'counts' => counts } )
+			end
+
+			# Returns all the counts for 
+			# 
+			# @raise [StartupStats::Error::ParamsError]
+			# @param date [Integer]
+			# @return [StartupStats::ApiResult]
+			def counts_for_day( date )
+				res = send( :get , "counts" , { 'date' => date , 'db_id' => @db_id } )
+				counts = []
+				res[:body][:counts].each{ |count|
+					c = StartupStats::Countdb::Count.new
+					c.key = count[:key]
+					c.db_id = @db_id
+					c.count = count[:count]
+					c.date = count[:date]
+					counts.push( c )
+				}
+				StartupStats::ApiResult.new( { 'total_count' => counts.length , 'start' => 0 , 'limit' => 0 , 'counts' => counts } )
+			end
+
+			# Deletes a count for a date
+			#
+			# @raise [StartupStats::Error::ParamsError]
+			# @param key [String]
+			# @param date [Integer]
+			# return [Boolean]
+			def delete_count( key , date )
+				res = send( :delete , "counts" , { 'key' => key , 'date' => date , 'db_id' => @db_id } )
+				( res[:status] == 200 )
+			end
+
+			# Deletes all counts for a key
+			# 
+			# @raise [StartupStats::Error::ParamsError]
+			# @param key [String]
+			# return [Boolean]
+			def delete_counts( key )
+				res = send( :delete , "counts" , { 'key' => key , 'db_id' => @db_id } )
+				( res[:status] == 200 )
+			end
+		end
+	end
+end

data/lib/startupstats/countdb/models/count.rb

@@ -0,0 +1,7 @@
+module StartupStats
+	module Countdb
+		class Count
+			attr_accessor :key , :db_id , :count , :date
+		end
+	end
+end

data/lib/startupstats/error/params_error.rb

@@ -0,0 +1,9 @@
+require 'startupstats/error'
+
+module StartupStats
+  class Error
+    # Raised when a client is provided invalid params
+    class ParamsError < StartupStats::Error
+    end
+	end
+end

data/lib/startupstats/formd/filings.rb

@@ -16,7 +16,7 @@ module StartupStats
 			def filings( start , limit , industry )
 				begin
 					result = parse_filings_from_response(:get , "filings", {start: start , limit: limit , industry: industry} )
-					result.result_set
+					result.filings
 				rescue StartupStats::Error::Unauthorized => error
 					raise
 				end
@@ -69,7 +69,7 @@ module StartupStats
 					parsed_filings.push( StartupStats::Formd::Filing.new filing )
 				}
 				
-				StartupStats::ApiResult.new( { :result_set => parsed_filings , :total_count => body[:total_count] , :start => body[:start] , :limit => body[:limit] } )
+				StartupStats::ApiResult.new( { :filings => parsed_filings , :total_count => body[:total_count] , :start => body[:start] , :limit => body[:limit] } )
 			end
 		end
 	end

data/lib/startupstats/response/api_result.rb

@@ -1,10 +1,47 @@
+require 'startupstats/error/params_error'
 module StartupStats
 	class ApiResult
-		attr_accessor :result_set , :total_count , :start , :limit
+		attr_accessor :total_count , :start , :limit, :errors, :counts , :filings 
+
+		# include Enumerable
+
 		def initialize args = {}
+			@counts = []
+			@filings = []
+			@errors = []
 			args.each do |k, v|  
 				instance_variable_set("@#{k}",v) unless v.nil?
 			end
 		end
+
+		def success?
+			( @errors.length == 0 )
+		end
+
+		# TODO: Get method_missing working to define counts & filings in result_sets rather than standalone variables
+
+		# def method_missing( name , *args , &block )
+		# 	if name.to_s =~ /^(.+)s$/
+		# 		if name[-1] == "="
+		# 			base_name = name[0..2].to_sym
+		# 			define_singleton_method name , lambda{ |value| @result_sets[base_name]  }
+		# 			define_method(name) do |value|
+		# 				@result_sets[base_name] = value
+		# 			end
+		# 			@result_sets[base_name] = args[0]
+		# 		else
+		# 			define_method(name) do 
+		# 				@result_sets[name]
+		# 			end
+		# 			@result_sets[name]
+		# 		end
+		# 	else
+		# 		super
+		# 	end
+		# end
+
+		# def each
+		# 	@result_set.each
+		# end
 	end
 end

data/lib/startupstats/version.rb

@@ -1,3 +1,3 @@
 module StartupStats
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/api_result_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require "startupstats/response/api_result"
+describe StartupStats::ApiResult do
+	context "instance methods" do
+		describe "#new" do
+			subject { build(:api_result) }
+			
+			it { should respond_to(:start) }
+			it { should respond_to(:limit) }
+			it { should respond_to(:errors) }
+			it { should respond_to(:total_count) }
+
+			context "with counts" do
+				before do
+					@result = build(:result_with_counts)
+				end
+
+				it "has 1 count" do
+					@result.counts.length.should eq 1
+				end
+			end
+
+			context "with filings" do
+				before do
+					@result = build(:result_with_filings)
+				end
+
+				it "has 1 filing" do
+					@result.filings.length.should eq 1
+				end
+			end
+		end
+
+		describe "#success?" do
+
+			context "with errors" do
+				before do
+					@result = build(:result_with_errors)
+				end
+
+				it "returns false" do
+					@result.success?.should eq false
+				end
+			end
+
+			context "without errors" do
+				before do
+					@result = build(:api_result)
+				end
+
+				it "returns true" do
+					@result.success?.should eq true
+				end
+			end
+		end
+
+		describe "#message" do
+			before do
+				@result = build(:result_with_errors)
+			end
+
+			it "returns a string representation of the errors" 
+		end
+
+		describe "custom result sets" do
+			it "sets counts"
+
+			it "sets filings"
+		end
+	end
+end

data/spec/countdb/client_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+module StartupStats
+	module Countdb
+		describe Client do
+			describe "#new" do
+				before do
+					@params = attributes_for(:countdb_client)
+					@client = StartupStats::Countdb::Client.new(@params)
+				end
+				it "initializes a new client" do
+					StartupStats::Countdb::Client.new(@params).should be_an_instance_of( StartupStats::Countdb::Client )
+				end
+
+				# it "requires a db_id to be set" do
+				# 	@params.delete(:db_id)
+				# 	expect {
+				# 		StartupStats::Countdb::Client.new(@params)
+				# 	}.to raise_error( StartupStats::Error::ParamsError )
+				# end
+
+				it "sets access_token_key to token" do
+					StartupStats::Countdb::Client.new(@params).access_token_key.should eq "token"
+				end
+			end
+		end
+	end
+end

data/spec/countdb/count_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+describe StartupStats::Countdb::Count do
+	context "instance methods" do
+		describe "#new" do
+			subject { build( :count ) }
+
+			it { should respond_to(:db_id) }
+			it { should respond_to(:key) }
+			it { should respond_to(:count) }
+			it { should respond_to(:date) }
+		end
+	end
+end

data/spec/countdb/counts_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+require 'vcr'
+describe StartupStats::Countdb::Counts do
+	use_vcr_cassette 'counts' , :record => :new_episodes
+
+	context "with valid data" do
+		before(:all) do
+			# COUNTDB_ADMIN is the key necessary to create & destroy countdb databases
+			@db_client = StartupStats::Countdb::Client.new({
+								access_token: 		ENV['COUNTDB_ADMIN'] ,
+								access_token_key: 	"admin_key" ,
+								endpoint:			ENV['COUNTDB_ENDPOINT'] })
+			VCR.use_cassette( 'counts' ) do
+				@db_token = @db_client.send( :post , "dbs" , { 'id' => 'rspec' , 'name' => 'rspec testing db' } )[:body][:db][:token]
+			end
+
+			@client = StartupStats::Countdb::Client.new({
+									db_id: 				'rspec' ,
+									access_token: 		@db_token ,
+									access_token_key: 	"token" ,
+									endpoint:			ENV['COUNTDB_ENDPOINT'] })
+		end
+
+		after(:all) do
+			# delete the test database
+			VCR.use_cassette( 'counts' ) do
+				@db_client.send( :delete , "dbs" , { 'id' => 'rspec' , 'token' => @db_token } )
+			end
+		end
+
+		describe "#increment_key" do
+			it "calls request with post to counts" do
+				@client.should_receive(:request).with( :post , 'counts' , anything ).and_return( { status: 200 } )
+				@client.increment_key( 'instagram.com' , 123 )
+			end
+
+			it "returns true or false based on a result" do
+				@client.increment_key( 'instagram.com' , 123 ).should == true
+			end
+
+			it "raises a ParamsError if key is empty" do
+				expect {
+					@client.increment_key( '' , 0 )
+				}.to raise_error( StartupStats::Error::ParamsError )
+			end
+
+			it "raises a ParamsError if count is not a number" do
+				expect {
+					@client.increment_key( 'i' , '' )
+				}.to raise_error( StartupStats::Error::ParamsError )
+			end
+		end
+
+		describe "#increment_key_for_date" do
+			it "calls request with post to counts" do
+				@client.should_receive(:request).with( :post , 'counts' , anything ).and_return( { status: 200 } )
+				@client.increment_key_for_date( 'instagram.com' , 123 , Date.today.jd )
+			end
+
+			it "returns true or false based on a result" do
+				@client.increment_key_for_date( 'instagram.com' , 123 , Date.today.jd - 1 ).should == true
+			end
+
+			it "raises a ParamsError if date is empty" do
+				expect {
+					@client.increment_key_for_date( '' , 0 , '' )
+				}.to raise_error( StartupStats::Error::ParamsError )
+			end
+		end
+
+		describe "#counts_for_key" do
+
+			it "calls request with get to counts/:key" do
+				@client.should_receive(:request).with( :get , 'counts/instagram.com' , anything ).and_return( { :body => { :counts => [] }  } )
+				@client.counts_for_key( 'instagram.com' )
+			end
+			
+			it "returns a StartupStats::ApiResult instance" do
+				@client.counts_for_key( 'instagram.com' ).should be_an_instance_of( StartupStats::ApiResult )
+			end
+
+			it "includes a count object in the result" do
+				@client.counts_for_key( 'instagram.com' ).counts[0].should be_an_instance_of( StartupStats::Countdb::Count )
+			end
+		end
+
+		describe "#counts_for_day" do
+			it "calls request with get to counts" do
+				@client.should_receive(:request).with( :get , 'counts' , anything ).and_return( { :body => { :counts => [] }  } )
+				@client.counts_for_day( Date.today.jd )
+			end
+
+			it "returns a StartupStats::ApiResult instance" do
+				@client.counts_for_day( Date.today.jd ).should be_an_instance_of( StartupStats::ApiResult )
+			end
+
+			it "includes a count object in the result" do
+				@client.counts_for_day( Date.today.jd ).counts[0].should be_an_instance_of( StartupStats::Countdb::Count )
+			end
+		end
+
+		describe "#delete_count" do
+			# two counts were created above with increment_key and increment_key_for_date
+			it "calls request with delete to counts" do
+				@client.should_receive(:request).with( :delete , 'counts' , anything ).and_return( { status: 200 } )
+				@client.delete_count( 'instagram.com' , Date.today.jd )
+			end
+
+			it "deletes a count" do
+				expect {
+					@client.delete_count( 'instagram.com' , Date.today.jd - 1 )
+				}.to change { @client.counts_for_key( 'instagram.com' ).counts.length }.from(2).to(1)
+			end
+
+			it "returns true if successful" do
+				@client.delete_count( 'instagram.com' , Date.today.jd - 1 ).should eq true
+			end
+		end
+
+		describe "#delete_counts" do
+			it "calls request with delete to counts" do
+				@client.should_receive(:request).with( :delete , 'counts' , anything ).and_return( { status: 200 } )
+				@client.delete_counts( 'instagram.com' )
+			end
+			it "deletes all counts for a key" do
+				expect {
+					@client.delete_counts( 'instagram.com' )
+				}.to change { @client.counts_for_key( 'instagram.com' ).counts.length }.from(1).to(0)
+			end
+
+			it "returns true" do
+				@client.delete_counts( 'instagram.com' ).should eq true
+			end
+		end
+	end
+end

data/spec/factories.rb

@@ -1,5 +1,12 @@
+require 'startupstats/error/client_error'
 FactoryGirl.define do
 	
+	factory :countdb_client , class: StartupStats::Countdb::Client do
+		access_token		"kjhk89yh98h98h87g76f6f76f76f76"
+		db_id				"tb"
+		endpoint			"http://localhost:4567/"
+	end
+
 	factory :filing , class: StartupStats::Formd::Filing do
 		filing_url_html			"http://www.sec.gov/Archives/edgar/data/1525533/000152553312000003/xslFormDX01/primary_doc.xml"
 		filing_url_xml			"http://www.sec.gov/Archives/edgar/data/1525533/000152553312000003/primary_doc.xml"
@@ -97,4 +104,30 @@ FactoryGirl.define do
 	factory :security do
 		name 					"Equity"
 	end
+
+	factory :count , class: StartupStats::Countdb::Count do
+		sequence(:key){ |n| "instagram#{n}.com" }
+		db_id 		"tb"
+		count 		123
+		date 		{ Date.today.jd }
+	end
+
+	factory :api_result , class: StartupStats::ApiResult do
+		# :result_set , :total_count , :start , :limit , :errors 
+		
+		start 		0
+		limit 		10
+
+		factory :result_with_errors do
+			errors 		[ StartupStats::Error::ClientError.new() ]
+		end
+
+		factory :result_with_counts do
+			counts 		[ FactoryGirl.build(:count) ]
+		end
+
+		factory :result_with_filings do
+			filings 	[ FactoryGirl.build(:filing) ]
+		end
+	end
 end

data/spec/formd/filings_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'vcr'
 describe StartupStats::Formd::Filings do
 	use_vcr_cassette 'filings' , :record => :new_episodes
+
 	context "without valid authentication" do
 		let(:client){ StartupStats::Formd::Client.new({
 							:access_token 		=> "" ,

data/spec/spec_helper.rb

@@ -7,13 +7,18 @@ require 'factory_girl'
 require 'factories'
 require 'vcr'
 
-Dir['./spec/support/**/*.rb'].each { |f| require f }
+Dir['./spec/support/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
+  config.extend VCR::RSpec::Macros
   config.include FactoryGirl::Syntax::Methods
 
   config.mock_with :rspec
 
   config.run_all_when_everything_filtered = true
   config.color_enabled = true
+
+  # Add VCR to the StartupStats faraday middleware
+  StartupStats::Default::MIDDLEWARE.insert(4,VCR::Middleware::Faraday)
+  # StartupStats::Default::MIDDLEWARE.insert(4, Faraday::Response::Logger)
 end

data/spec/support/vcr_support.rb

@@ -3,9 +3,6 @@ require 'vcr'
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/vcr'
   c.hook_into :faraday
-  #c.default_cassette_options = { :record => :once }
-end
-
-RSpec.configure do |c|
-  c.extend VCR::RSpec::Macros
+  #c.debug_logger = $stdout
+  c.ignore_localhost = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: startupstats
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -138,6 +138,9 @@ files:
 - lib/startupstats.rb
 - lib/startupstats/configurable.rb
 - lib/startupstats/core_ext/hash.rb
+- lib/startupstats/countdb/client.rb
+- lib/startupstats/countdb/counts.rb
+- lib/startupstats/countdb/models/count.rb
 - lib/startupstats/default.rb
 - lib/startupstats/error.rb
 - lib/startupstats/error/bad_gateway.rb
@@ -149,6 +152,7 @@ files:
 - lib/startupstats/error/internal_server_error.rb
 - lib/startupstats/error/not_acceptable.rb
 - lib/startupstats/error/not_found.rb
+- lib/startupstats/error/params_error.rb
 - lib/startupstats/error/server_error.rb
 - lib/startupstats/error/unauthorized.rb
 - lib/startupstats/formd/client.rb
@@ -160,6 +164,10 @@ files:
 - lib/startupstats/response/parse_json.rb
 - lib/startupstats/response/raise_error.rb
 - lib/startupstats/version.rb
+- spec/api_result_spec.rb
+- spec/countdb/client_spec.rb
+- spec/countdb/count_spec.rb
+- spec/countdb/counts_spec.rb
 - spec/factories.rb
 - spec/formd/client_spec.rb
 - spec/formd/company_spec.rb
@@ -191,11 +199,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the network of StartupStats APIs.
 test_files:
+- spec/api_result_spec.rb
+- spec/countdb/client_spec.rb
+- spec/countdb/count_spec.rb
+- spec/countdb/counts_spec.rb
 - spec/factories.rb
 - spec/formd/client_spec.rb
 - spec/formd/company_spec.rb