kickstapi 0.0.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fa7c8fb3235af0c4bcb98666500470c7f6eefcc
-  data.tar.gz: 59ca695e6b72d9a670e1840482b53a207bbaa478
+  metadata.gz: e7a27eb2fdb171795742943d1dcdf6f7dcc13856
+  data.tar.gz: d2c7e82ac82d04e2399274f8dc5c2ad5c202e559
 SHA512:
-  metadata.gz: 0f7c87564e5c0bbe1db9c07a14c33b241af76ef2ed1dcaa515277eb6dbfcf155d4e19b368d29ef1fff923fc99443e54f45b8bca31c9be737796becf1df7b9d49
-  data.tar.gz: 6e58f01a22e1dc046fb1091eb578f8b88dcb9990686b7b69ba6fa4d2abbbd5cd9a4a5361c53db79e9885803ddf5390c99d024d700e90feb1c1fedc681a34b056
+  metadata.gz: 38c7392691d07678ade9e2400bb67a7d1c2fb1e422121f20457a774cf309f62757b510fef1e06daed6fc9230ead26ed8369f785b6ff654d433223bcb2929690c
+  data.tar.gz: f4bb5fb43a88e151a782f99fe780e3c05ce13d4e4ac33cf29df7e166cc1b41d95ce891e41c2ad592b3fec66928311799cf2f2108676fcc06aba4f68dd2101b6a

data/README.md

@@ -1,4 +1,4 @@
-# Kickstapi  [![Build Status](https://travis-ci.org/kvannotten/kickstapi.png?branch=master)](https://travis-ci.org/kvannotten/kickstapi)
+# Kickstapi  [![Build Status](https://travis-ci.org/kvannotten/kickstapi.png?branch=master)](https://travis-ci.org/kvannotten/kickstapi) [![Gem Version](https://badge.fury.io/rb/kickstapi.svg)](http://badge.fury.io/rb/kickstapi)
 
 This gem scrapes Kickstarter to create an API that facilitates the creation of applications querying Kickstarter.
 
@@ -24,20 +24,28 @@ Or install it yourself as:
 require 'kickstapi'
 
 # this gives you an array of Project objects containing 'Planetary Annihilation'
-projects = Kickstapi.search_projects "Planetary Annihilation"
+projects = Kickstapi.find_projects_with_filter "Planetary Annihilation"
 
 # lets take the first project
 project = projects.first
 
 # we can then perform the following methods on it
-project.name
-project.url
-project.about
-project.creator
-project.pledged
-project.percentage_funded
-project.backers
-project.status
+project.name                    # returns the name of the project
+project.id                      # returns the id of the project
+project.url                     # returns the url of the project
+project.creator                 # returns the name of the creator
+# The methods above are always available, the methods below
+# will be lazy loaded when requested (this requires an additional
+# HTML request)
+project.about                   # returns the about section
+project.pledged                 # returns the total amount pledged
+project.percentage_funded       # returns the percentage of funds that have been achieved so far
+project.backers                 # returns the amount of backers
+project.status                  # returns if the project is cancelled or succesful or still running
+project.currency                # returns the currency type (USD, CAD, GBP, EUR, ...)
+project.goal                    # returns the fund goal
+project.end_date                # returns the date that the project (will) end(s)
+project.hours_left              # returns how many hours are still left on the project
 
 ```
 

data/lib/kickstapi/ghostly.rb

@@ -0,0 +1,32 @@
+module Kickstapi
+  module Ghostly
+    module Macros
+      private
+      def lazy_accessor(*names)
+        names.each do |name|
+          attr_writer name
+          define_method(name) do
+            load
+            instance_variable_get("@#{name}")
+          end
+        end
+      end
+    end
+
+    def self.included(other)
+      other.extend(Macros)
+    end
+
+    attr_accessor :data_source
+    attr_writer   :load_state
+
+    def load_state
+      @load_state ||= :ghost
+    end
+
+    def load
+      return if load_state == :loaded
+      data_source.load(self)
+    end
+  end
+end

data/lib/kickstapi/kickstarter_gateway.rb

@@ -0,0 +1,58 @@
+require 'mechanize'
+require 'json'
+
+module Kickstapi
+  class KickstarterGateway
+
+    def projects_with_name(filter, offset = 1)
+      search_url = "http://www.kickstarter.com/projects/search?page=#{offset}utf8=%E2%9C%93&term=#{URI::encode filter}"
+
+      projects = []
+      should_page = true
+      
+      agent.get(search_url) do |page|
+        page.search("div.project-card-wrap").each do |project|
+          p = Hash.new(0)
+          
+          bb_card = project.search("h2.bbcard_name")
+          bb_card_link = bb_card.search("a").first
+
+          p[:name] = bb_card_link.content
+          p[:url] = "https://www.kickstarter.com#{bb_card_link.attributes["href"].value.split('?').first}"
+          p[:id] = JSON.parse(project.attributes["data-project"])["id"].to_i 
+          p[:creator] = project.search(".bbcard_name span").text.gsub(/\n|by/, '')
+
+          projects << p 
+        end
+        should_page = projects.count > 0
+      end
+
+      [projects, should_page]
+    end
+
+    def project_by_url(url)
+      project = {}
+      agent.get(url) do |page|
+        project[:name] = page.search(%Q{//h2[@class='mb1']//a}).text
+        project[:creator] = page.search(%Q{//span[@class='creator']//a}).text
+        project[:url] = url
+        project[:id] = page.search('div').select { |div| div[:class] =~ /^Project\d+/ }.map { |div| div[:class].to_s }.uniq.first.scan(/(\d+)/).flatten.first.to_i
+        project[:backers] = page.search(%Q{//data[@itemprop='Project[backers_count]']}).first.attributes["data-value"].value.to_i
+        project[:pledged] = page.search(%Q{//data[@itemprop='Project[pledged]']}).first.attributes["data-value"].value.to_f
+        project[:goal] = page.search(%Q{//div[@id='pledged']}).first.attributes['data-goal'].value.to_f
+        project[:currency] = page.search(%Q{//data[@itemprop='Project[pledged]']}).first.attributes["data-currency"].value
+        project[:percentage_funded] = page.search(%Q{//div[@id='pledged']}).first.attributes['data-percent-raised'].value.to_f * 100
+        project[:end_date] = DateTime.parse page.search(%Q{//span[@id='project_duration_data']}).first.attributes['data-end_time'].value
+        project[:hours_left] = page.search(%Q{//span[@id='project_duration_data']}).first.attributes['data-hours-remaining'].value.to_f
+      end
+      project
+    end
+
+    private 
+
+    def agent
+      @agent ||= Mechanize.new
+    end
+
+  end
+end

data/lib/kickstapi/project.rb

@@ -1,15 +1,37 @@
 require 'json'
+require 'kickstapi/ghostly'
 
 module Kickstapi
   class Project
-    attr_accessor :id, :name, :url, :creator, :about, 
-                  :pledged, :goal, :currency, :percentage_funded, :backers, 
-                  :status, :end_date
+    include Ghostly
+
+    attr_accessor :id, :name, :url, :creator
+    lazy_accessor :about,  :pledged, :goal, 
+                  :currency, :percentage_funded, :backers, 
+                  :status, :end_date, :hours_left
                   
+    def initialize(attributes = {})
+      complete(attributes)
+    end
+
+    def complete(attributes)
+      attributes.each do |key, value|
+        public_send("#{key}=", value)
+      end
+    end
+
+    def to_s
+      inspect
+    end
+
+    def ==(other)
+      other.is_a?(Project) && other.id == id
+    end
+
     def to_hash
       hash = {}
       self.instance_variables.each do |var|
-        sym = var.to_s.gsub /@/, ''
+        sym = var.to_s.gsub(/@/, '')
         hash[sym.to_sym] = self.instance_variable_get var
       end
       hash

data/lib/kickstapi/project_mapper.rb

@@ -0,0 +1,69 @@
+require 'kickstapi/project'
+
+module Kickstapi
+  class ProjectMapper
+    attr_reader :gateway
+
+    def initialize(gateway)
+      @gateway = gateway
+    end
+
+    def projects_by_filter(filter, max_results = :all)
+      page = 1
+      should_page = true
+      projects = []
+
+      loop do
+        break unless should_page
+        break unless max_results == :all || max_results.to_i >= projects.size
+
+        projects_hashes, should_page = @gateway.projects_with_name(filter, page)
+        page += 1
+
+        projects_hashes.each do |project_hash|
+          project = Project.new(data_source: self)
+
+          project.complete(project_hash)
+
+          projects << project
+        end
+        
+      end
+      projects = projects[0...max_results] unless max_results == :all
+      projects
+    end
+
+    def project_by_url(url)
+      project_hash = @gateway.project_by_url(url)
+      project = Project.new(data_source: self)
+      project.url = project_hash[:url]
+
+      fill_project(project, project_hash)
+      project
+    end
+
+    def load(project)
+      fill_project(project, @gateway.project_by_url(project.url))
+    end
+
+    private
+
+    def fill_project(project, project_hash = {})
+      project.complete(project_hash)
+      project.load_state = :loaded
+      if project.pledged < project.goal
+        if project.end_date < DateTime.now
+          project.status = :failed
+        else
+          project.status = :running_not_yet_achieved
+        end
+      else
+        if project.end_date < DateTime.now
+          project.status = :succesful
+        else
+          project.status = :running_already_achieved
+        end
+      end
+    end
+  end
+end

data/lib/kickstapi/version.rb

@@ -1,3 +1,3 @@
 module Kickstapi
-  VERSION = "0.0.4"
+  VERSION = "0.1.5"
 end

data/lib/kickstapi.rb

@@ -1,74 +1,25 @@
 require "kickstapi/version"
 require "kickstapi/project"
+require "kickstapi/kickstarter_gateway"
+require "kickstapi/project_mapper"
+require "kickstapi/ghostly"
 
 require 'open-uri'
 require 'mechanize'
 
 module Kickstapi
-  def self.get_agent
-    @agent ||= Mechanize.new
-  end
-  
-  def self.search_projects( filter = "", offset = 1)
-    search_url = "http://www.kickstarter.com/projects/search?page=#{offset}utf8=%E2%9C%93&term=#{URI::encode filter}"
+  def self.find_projects_with_filter(filter, max_results = :all)
+    gw = Kickstapi::KickstarterGateway.new
+    mapper = Kickstapi::ProjectMapper.new(gw)
 
-    projects = []
-    Kickstapi.get_agent.get(search_url) do |page|
-      page.search("div.project-card").each do |project|
-        p = Project.new
-        bb_card = project.search("h2.bbcard_name")
-        bb_card_link = bb_card.search("a").first
+    mapper.projects_by_filter filter, max_results
+  end
 
-        p.name = bb_card_link.content
-        p.url = bb_card_link.attributes["href"].value.split('?').first
-        p.id = p.url.scan(/\/(\d+)\//).flatten.first.to_i
-        bb_card_author = bb_card.search("span").first
-        p.creator =  bb_card_author.content.gsub(/\nby\n/, '').gsub(/\n/, '')
-        p.about = project.search("p.bbcard_blurb").first.content.strip
-        
-        if project.search(".project-failed").first.nil? then
-          pledged = project.search("strong.project-pledged-amount").first.content.gsub(/\n/, '').gsub(/pledged/, '')
-          
-          p.pledged = pledged[1, pledged.length].gsub(',', '').to_f
-          p.currency = pledged[0, 1]
-          p.percentage_funded = project.search("strong.project-pledged-percent").first.content.gsub(/\n/, '').gsub(/funded/, '')
-          p.backers = project.search("li.middle").first.search("strong").first.content.gsub(/\n/, '')
-          if project.search("li.ksr_page_timer").first.nil? then
-            p.status = project.search("li.last").first.search("strong").first.content 
-          else
-            p.end_date = DateTime.parse(project.search("li.ksr_page_timer").first.attributes["data-end_time"].value)
-            p.status = "Running"
-          end
-        else
-          p.status = "Failed"
-        end
-        projects << p
-      end
-    end
+  def self.find_project_by_url(url)
+    gw = Kickstapi::KickstarterGateway.new
+    mapper = Kickstapi::ProjectMapper.new(gw)
 
-    projects
-  end
-  
-  def self.get_project name
-      return Kickstapi.search_projects(name).first 
+    mapper.project_by_url url
   end
-  
-  def self.get_project_by_url url
-    p = Project.new
-    Kickstapi.get_agent.get(url) do |page|
-      p.name = page.search(%Q{//h2[@class='mb1']//a}).text
-      p.creator = page.search(%Q{//span[@class='creator']//a}).text
-      p.url = url
-      p.id = p.id = p.url.scan(/\/(\d+)\//).flatten.first.to_i
-      p.backers = page.search(%Q{//data[@itemprop='Project[backers_count]']}).first.attributes["data-value"].value.to_i
-      p.pledged = page.search(%Q{//data[@itemprop='Project[pledged]']}).first.attributes["data-value"].value.to_f
-      p.goal = page.search(%Q{//div[@id='pledged']}).first.attributes['data-goal'].value
-      p.currency = page.search(%Q{//data[@itemprop='Project[pledged]']}).first.attributes["data-currency"].value
-      p.percentage_funded = page.search(%Q{//div[@id='pledged']}).first.attributes['data-percent-raised'].value.to_f * 100
-      p.end_date = DateTime.parse page.search(%Q{//span[@id='project_duration_data']}).first.attributes['data-end_time'].value
-    end
-    
-    p
-  end
-  
+
 end

data/spec/kickstapi_spec.rb

@@ -6,9 +6,8 @@ describe Kickstapi do
   end
   
   before :all do
-    @projects = Kickstapi.search_projects "Planetary Annihilation" # succesful project
-    @failure = Kickstapi.get_project "Quala" # failing project
-    @single_project = Kickstapi.get_project_by_url "http://www.kickstarter.com/projects/659943965/planetary-annihilation-a-next-generation-rts?ref=live"
+    @projects = Kickstapi.find_projects_with_filter "Planetary Annihilation" # succesful project
+    @failure = Kickstapi.find_projects_with_filter("Quala").first # failing project
   end
 
   context 'projects' do
@@ -24,44 +23,55 @@ describe Kickstapi do
     
     its(:to_hash) { should be_kind_of Hash }
     
-    [ :id, :name, :url, :creator, 
-      :about, :pledged, :currency, 
-      :percentage_funded, :backers, 
-      :status].each do |method|
-      it { should respond_to method }
-      its(method) { should_not be_nil }
-      its(:to_hash) { should have_key method }
-    end
-    
     its(:id) { should be_kind_of Fixnum }
-    its(:id) { should > 0 }
     
     its(:pledged) { should be_kind_of Float }
     
     it "returns valid json" do
-      expect { JSON.parse @projects.first.to_json }.to_not raise_error JSON::ParserError
+      expect { JSON.parse @projects.first.to_json }.not_to raise_error 
     end
-  end
-  
-  context 'project by URL' do
-    subject { @single_project }
-    
-    [ :id, :name, :url, :creator,
-      :pledged, :currency, 
-      :percentage_funded, :backers, 
-      :goal].each do |method|
-      it { should respond_to method }
-      its(method) { should_not be_nil }
-      its(:to_hash) { should have_key method }
+
+    it "should be in ghost state when first fetched" do
+      temp_project = Kickstapi.find_projects_with_filter("Ewe Topia").first
+      temp_project.load_state.should be_eql :ghost
     end
-  end
-  
-  context 'failed project' do
-    subject { @failure }
-    
-    its(:status) { should eql "Failed" }
-    [:pledged, :percentage_funded, :backers].each do |method|
-      its(method) { should be_nil }
+
+    it "should do an initial fetch of some fields, while in ghost state" do
+      temp_project = Kickstapi.find_projects_with_filter("Ewe Topia").first
+      temp_project.id
+      temp_project.creator
+      temp_project.url
+      temp_project.name
+      temp_project.load_state.should be_eql :ghost
+    end
+
+    it "should lazily load all the arguments" do
+      temp_project = Kickstapi.find_projects_with_filter("Ewe Topia").first
+      temp_project.backers # fetch an item that is lazily loaded
+      temp_project.load_state.should be_eql :loaded
+    end
+
+    it "should be retrievable from it's URL" do
+      temp_project = Kickstapi.find_project_by_url(@failure.url)
+      temp_project.name.should be_eql @failure.name
+    end
+
+    it "should be comparable" do
+      temp_project = Kickstapi.find_project_by_url(@projects.first.url)
+      (temp_project == @projects.first).should be_true
+    end
+
+    it "should be different from another project" do
+      (@projects.first == @failure).should be_false
+    end
+
+    it "should mark a successful project" do
+      @projects.first.status.should be_eql :succesful
+    end
+
+    it "should mark an unsuccessful project" do
+      @failure.status.should be_eql :failed
     end
   end
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kickstapi
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Kristof Vannotten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,7 +96,10 @@ files:
 - Rakefile
 - kickstapi.gemspec
 - lib/kickstapi.rb
+- lib/kickstapi/ghostly.rb
+- lib/kickstapi/kickstarter_gateway.rb
 - lib/kickstapi/project.rb
+- lib/kickstapi/project_mapper.rb
 - lib/kickstapi/version.rb
 - spec/kickstapi_spec.rb
 - spec/spec_helper.rb
@@ -127,3 +130,4 @@ summary: This gem offers an API for Kickstarter
 test_files:
 - spec/kickstapi_spec.rb
 - spec/spec_helper.rb
+has_rdoc: