kickscraper 0.2.0

data/lib/kickscraper/client/category.rb

@@ -0,0 +1,18 @@
+module Kickscraper
+    class Category < Api
+        attr_accessor :projects
+
+        def to_s
+            name
+        end
+
+        def inspect
+            "<Category: '#{to_s}'>"
+        end
+
+        def projects
+            return [] unless @projects || self.urls.web.discover
+            @projects ||= Kickscraper.client.process_api_url("Projects", self.urls.web.discover)
+        end
+    end
+end

data/lib/kickscraper/client/comment.rb

@@ -0,0 +1,5 @@
+module Kickscraper
+    class Comment < Api
+      
+    end
+end

data/lib/kickscraper/client/project.rb

@@ -0,0 +1,71 @@
+require_relative 'user.rb'
+require_relative 'category.rb'
+
+module Kickscraper
+    class Project < Api
+        coerce_key :creator, Kickscraper::User
+        coerce_key :category, Kickscraper::Category
+
+        attr_accessor :comments, :updates, :rewards
+
+        def to_s
+            name
+        end
+
+        def inspect
+            "<Project: '#{to_s}'>"
+        end
+
+        def reload!
+            if self.urls.api.nil?
+              the_full_project = Kickscraper.client.find_project(self.id)
+              project_api_url = the_full_project.nil? ? nil : the_full_project.urls.api.project
+            else
+              project_api_url = self.urls.api.project
+            end
+            @raw = Kickscraper.client.process_api_url("Project", project_api_url, false) unless project_api_url.nil?
+            Kickscraper::Project::do_coercion(self)
+        end
+
+        def successful?
+            pledged >= goal
+        end
+
+        def active?
+            state == "live"
+        end
+
+        def comments
+            return @comments if @comments
+
+            # must reload to get urls.api, not returned in public discover search
+            reload! unless (self.urls.api && self.urls.api.comments)
+
+            # if logged in and can use private API, self.urls.api.updates should now be defined
+            if (self.urls.api && self.urls.api.updates)
+              @comments = Kickscraper.client.process_api_url("Comments", self.urls.api.comments)
+            else
+              @comments= []
+            end
+        end
+
+        def updates
+            return @updates if @updates
+
+            # must reload to get urls.api, not returned in public discover search
+            reload! unless (self.urls.api && self.urls.api.updates)
+
+            # if logged in and can use private API, self.urls.api.updates should now be defined
+            if (self.urls.api && self.urls.api.updates)
+              @updates = Kickscraper.client.process_api_url("Updates", self.urls.api.updates)
+            else
+              @updates = []
+            end
+        end
+        
+        def rewards
+            reload! unless @raw['rewards']
+            @raw['rewards']
+        end
+    end
+end

data/lib/kickscraper/client/update.rb

@@ -0,0 +1,5 @@
+module Kickscraper
+    class Update < Api
+    	
+    end
+end

data/lib/kickscraper/client/user.rb

@@ -0,0 +1,34 @@
+module Kickscraper
+    class User < Api
+    	attr_accessor :backed_projects, :starred_projects
+
+    	def to_s
+    		name
+    	end
+
+        def reload!
+            @raw = Kickscraper.client.process_api_url("User", self.urls.api.user, false)
+            Kickscraper::User::do_coercion(self)
+        end
+        
+        def biography
+            reload! unless @raw['biography']
+            @raw['biography']
+        end
+
+        def backed_projects
+        	return [] unless self.urls.api.backed_projects
+            @backed_projects ||= Kickscraper.client.process_api_url("Projects", self.urls.api.backed_projects)
+        end
+
+        def starred_projects
+        	return [] unless self.urls.api.starred_projects
+            @starred_projects ||= Kickscraper.client.process_api_url("Projects", self.urls.api.starred_projects)
+        end
+        
+        def created_projects
+            return [] unless self.urls.api.created_projects
+            @created_projects ||= Kickscraper.client.process_api_url("Projects", self.urls.api.created_projects)
+        end
+    end
+end

data/lib/kickscraper/configure.rb

@@ -0,0 +1,11 @@
+module Kickscraper
+	module Configure
+
+		attr_accessor :email, :password, :token, :proxy
+
+		def configure
+      		yield self
+    	end
+	end
+
+end

data/lib/kickscraper/connection.rb

@@ -0,0 +1,63 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'uri/query_params'
+
+class KSToken < Faraday::Middleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    # replace '+' symbols in the query params with their original spaces, because there
+    # seems to be a bug in the way some versions of Fararay escape parameters with spaces
+    env[:url].query_params.each { |key, value|
+      env[:url].query_params[key] = value.tr('+', ' ')
+    }
+    
+    # add format=json to all public search requests, or add the oauth_token to all api requests once we have it
+    if env[:url].to_s.index('https://api.kickstarter.com').nil?
+      env[:url].query_params['format'] = 'json'
+    else
+      env[:url].query_params['oauth_token'] = Kickscraper.token unless Kickscraper.token.nil?
+    end
+    
+    # make the call
+    @app.call(env)
+  end
+end
+
+module Kickscraper
+  module Connection
+
+    private
+
+    def connection(api_or_search = "api")
+      options = {
+        :headers => {'Accept' => "application/json; charset=utf-8", 'User-Agent' => "Kickscraper/XXX"},
+        :ssl => {:verify => false},
+        :url => api_or_search == "api" ? "https://api.kickstarter.com" : "https://www.kickstarter.com",
+        :proxy => Kickscraper.proxy.nil? ? "" : Kickscraper.proxy
+      }
+      
+      if api_or_search == "api"
+        @api_connection ||= Faraday::Connection.new(options) do |connection|
+          connection.use Faraday::Request::UrlEncoded
+          connection.use FaradayMiddleware::Mashify
+          connection.use FaradayMiddleware::FollowRedirects
+          connection.use Faraday::Response::ParseJson
+          connection.use ::KSToken
+          connection.adapter(Faraday.default_adapter)
+        end
+      else
+        @search_connection ||= Faraday::Connection.new(options) do |connection|
+          connection.use Faraday::Request::UrlEncoded
+          connection.use FaradayMiddleware::Mashify
+          connection.use FaradayMiddleware::FollowRedirects
+          connection.use Faraday::Response::ParseJson
+          connection.use ::KSToken
+          connection.adapter(Faraday.default_adapter)
+        end
+      end
+    end
+  end
+end

data/lib/kickscraper/response.rb

@@ -0,0 +1,15 @@
+module Kickscraper
+  class Response
+
+  	attr_accessor :body
+
+    def initialize(res)
+      @body = res.body
+      return res.body
+    end
+
+    def error?
+    	return false
+    end
+  end
+end

data/lib/kickscraper/version.rb

@@ -0,0 +1,3 @@
+module Kickscraper
+  VERSION = "0.2.0"
+end

data/spec/category_spec.rb

@@ -0,0 +1,26 @@
+describe Kickscraper::Category do
+  let(:client) { Kickscraper.client }
+  let(:category) { client.categories.first }
+
+  context "loading category info" do
+    subject { category }
+
+    it { should be_a Kickscraper::Category }
+    its(:name) { should_not be_empty }
+    its(:projects_count) { should be > 0 }
+  end
+
+  context "urls" do
+    subject { category.urls }
+
+    it { should_not be_empty }
+    its(:web) { should_not be_empty }
+  end
+
+
+  context "projects" do
+    subject { category.projects }
+    it_returns "a collection", Kickscraper::Project
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,84 @@
+describe Kickscraper::Client do
+  let(:client) { Kickscraper.client }
+  
+  context "finds a user by id" do
+    subject(:user) { client.find_user TEST_USER_ID }
+    
+    its(:id) { should == TEST_USER_ID }
+    its(:name) { should == 'Zach Braff' }
+  end
+  
+  context "returns nil when finding a non-existent user" do
+    subject { client.find_user 9999 }
+
+    it { should be_nil }
+  end
+  
+  context "finds a project by id" do
+    subject(:project) { client.find_project TEST_PROJECT_ID }
+    
+    its(:id) { should == TEST_PROJECT_ID }
+    its(:slug) { should == TEST_PROJECT_SLUG }
+    its(:name) { should == TEST_PROJECT_NAME }
+  end
+  
+  context "finds a project by slug" do
+    subject(:project) { client.find_project TEST_PROJECT_SLUG }
+    
+    its(:id) { should == TEST_PROJECT_ID }
+    its(:slug) { should == TEST_PROJECT_SLUG }
+    its(:name) { should == TEST_PROJECT_NAME }
+  end
+  
+  context "returns nil when finding a non-existent project" do
+    subject { client.find_project 9999 }
+    it { should be_nil }
+  end
+  
+  describe ".ending_soon_projects" do
+    it_behaves_like "ending_soon projects"
+  end
+
+  describe ".recently_launched_project" do
+    it_behaves_like "recently_launched projects"
+  end
+
+  # findes recently launched projects with the 'newest_projects' method for backwards compatibility
+  describe ".newest_projects" do
+    it_behaves_like "newest_projects projects"
+  end
+
+  describe ".popular_projects" do
+    it_behaves_like "popular projects"
+  end
+
+  describe ".search_project" do
+    it_behaves_like "search projects"
+  end
+
+  # context "loads recently launched projects starting at a specific timestamp" do
+  #   subject { client.recently_launched_projects((Time.now - (2 * 24 * 60 * 60)).to_i) }
+  #   it_returns "a collection", Kickscraper::Project
+  # end
+  
+  # context "loads projects ending soon starting at a specific deadline" do
+  #   subject { client.ending_soon_projects((Time.now + (2 * 24 * 60 * 60)).to_i) }
+  #   it_returns "a collection", Kickscraper::Project
+  # end
+  
+  context "lists all categories" do
+    subject { client.categories }  
+    it_returns "a collection", Kickscraper::Category
+  end
+
+  context "loads a category from string" do
+    subject { client.category(TEST_CATEGORY_NAME) }
+    its(:name) { should eq TEST_CATEGORY_NAME }
+  end
+
+  context "loads a category from an id" do
+    subject { client.category(TEST_CATEGORY_ID) }
+    its(:name) { should eq TEST_CATEGORY_NAME }
+  end
+
+end

data/spec/kickscraper_spec.rb

@@ -0,0 +1,16 @@
+describe Kickscraper do
+  subject { Kickscraper.client }
+
+  it "accepts configuration" do
+    Kickscraper.email.should == KICKSCRAPER_TEST_API_EMAIL
+  end
+  
+  context "connects to the kickstarter api" do
+    it { should_not be_nil }
+    it { should be_a Kickscraper::Client }
+    
+    its(:user) { should_not be_nil }
+    its(:user) { should be_a Kickscraper::User }
+  end
+
+end

data/spec/no_email_password_client_spec.rb

@@ -0,0 +1,73 @@
+describe Kickscraper::Client do
+  context "no email no password client" do
+    before(:all) do
+      @save_token = Kickscraper.token
+      Kickscraper.token=nil
+    end
+  
+    after (:all) do
+      Kickscraper.token=@save_token
+    end
+  
+    let(:client) do
+      Kickscraper.configure do |config|
+        config.email = nil
+        config.password = nil
+      end
+      Kickscraper::Client.new
+    end
+    
+    describe ".find_user" do
+      subject(:user) { client.find_user TEST_USER_ID }
+
+      it { should be_nil } # don't know how to do on purely Public API
+    end
+
+    describe ".find_product" do
+      subject(:project) { client.find_project TEST_PROJECT_ID }
+
+      it { should be_nil } # don't know how to do on purely Public API
+    end
+    
+    describe ".categories" do
+      subject { client.categories }
+
+      it { should eq [] } # don't know how to do on purely Public API
+    end
+
+    describe ".category" do
+      context "loads a category from string" do
+        subject { client.category(TEST_CATEGORY_NAME) }
+
+        it { should be_nil } # don't know how to do on purely Public API
+      end
+
+      context "loads a category from an id" do
+        subject { client.category(TEST_CATEGORY_ID) }
+
+        it { should be_nil } # don't know how to do on purely Public API
+      end
+    end
+
+    describe ".ending_soon_projects" do
+      it_behaves_like "ending_soon projects" 
+    end
+
+    describe ".recently_launched_project" do 
+      it_behaves_like "recently_launched projects" 
+    end
+
+    # findes recently launched projects with the 'newest_projects' method for backwards compatibility
+    describe ".newest_projects" do 
+      it_behaves_like "newest_projects projects"
+    end
+
+    describe ".popular_projects" do 
+      it_behaves_like "popular projects" 
+    end
+
+    describe ".search_project" do
+      it_behaves_like "search projects"
+    end
+  end 
+end