kickstapi 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 202f1c5ea493fcf383df3a87f710f8506aed3bd8
-  data.tar.gz: dcba2cf074591251e5ffaadd43500b92e034d73e
+  metadata.gz: ec24eaf5d7b36b006e3700336d0c86cfbd390ac4
+  data.tar.gz: 40e0cab8496bb4a325edd23a71f610e3f3405c5c
 SHA512:
-  metadata.gz: 92a015b4dd986392ea283175951073ab90369e728724b60b1089f186f3ef6e3d736d1cff7721fd10dc558a224da1dc620ba7d2ba2807f3dc6acf9ac3a90d9820
-  data.tar.gz: 9509895f049e5dc8ae183b2f3f84a1e4a38be60c3008c55200b6d47a4b7486ba2beb2369c1c741bca35d77b7f305047815a9b91615003ab686860ff8581d4e7a
+  metadata.gz: 7c13f5d3f1d5bbf355ce58afdd7ebbf294d4a56fb8cc97677ef296d21b650f53865c2cd00987783a55bd3eb2c78d5c4a4de2b8544dae634bca3b249bbf1ff709
+  data.tar.gz: 99d92848c9908c2d8d9f583ecbdc9b58b3dc1f8edaa1f2170b8e2b3c103a462e5c84769c0fc988202804f8cd7d175d2f99c428d77851f52c8e38d605efd99dd9

data/.travis.yml

@@ -2,3 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.1

data/README.md

@@ -1,9 +1,17 @@
-# 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)
+# 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.png)](http://badge.fury.io/rb/kickstapi)
 
-This gem scrapes Kickstarter to create an API that facilitates the creation of applications querying Kickstarter.
+## General
+
+This gem scrapes Kickstarter to create an API that facilitates the creation of applications querying Kickstarter. It does this by parsing the HTML on the website itself. 
 
 Note that this library is not created nor endorsed by Kickstarter
 
+## Remarks
+
+Kickstarter offers an undocumented API, but recently added a disclaimer that it is against their ToS to use this API by third party applications. Regardless of this, I still want people to get access to Kickstart statistics in an easy way. So the only legal way to do this, is to parse the website itself, whom anyone is allowed visit. 
+
+This means that sometimes Kickstarter can change things, which might break functionality. I've written the project in such a way that it separates the scraping concerns from the actual objects and the mapping thereof. This means, that when a change occurs, it has no effect on the end-user methods that the gem offers, and is merely a backend change. So update often!
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/kickstapi/kickstarter_gateway.rb

@@ -66,7 +66,7 @@ module Kickstapi
         end
       end
 
-      p projects
+      projects
     end
 
     private 

data/lib/kickstapi/project.rb

@@ -40,6 +40,7 @@ module Kickstapi
       hash = {}
       self.instance_variables.each do |var|
         sym = var.to_s.gsub(/@/, '')
+        next if ['load_state', 'data_source'].include? sym
         hash[sym.to_sym] = self.instance_variable_get var
       end
       hash

data/lib/kickstapi/project_mapper.rb

@@ -72,7 +72,7 @@ module Kickstapi
         end
       else
         if project.end_date < DateTime.now
-          project.status = :succesful
+          project.status = :successful
         else
           project.status = :running_already_achieved
         end

data/lib/kickstapi/reward.rb

@@ -9,5 +9,19 @@ module Kickstapi
       end
     end
 
+
+    def to_hash
+      hash = {}
+      self.instance_variables.each do |var|
+        sym = var.to_s.gsub(/@/, '')
+        hash[sym.to_sym] = self.instance_variable_get var
+      end
+      hash
+    end
+    
+    def to_json(*a)
+      self.to_hash.to_json
+    end
+
   end
 end

data/lib/kickstapi/version.rb

@@ -1,3 +1,3 @@
 module Kickstapi
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/kickstapi_spec.rb

@@ -8,6 +8,7 @@ describe Kickstapi do
   before :all do
     @projects = Kickstapi.find_projects_with_filter "Planetary Annihilation" # succesful project
     @failure = Kickstapi.find_projects_with_filter("Quala").first # failing project
+    @project_by_name = Kickstapi.find_projects_by_username("kristofv").first
   end
 
   context 'projects' do
@@ -18,6 +19,14 @@ describe Kickstapi do
     it { should_not be_empty }
   end
   
+  context 'a username project' do
+    subject { @project_by_name }
+
+    its(:creator) { should be_eql :not_loaded } # the creator field cannot be fetched from this page
+
+    its(:name) { should_not be_eql :not_loaded } # the name object should still be fetched
+  end
+
   context 'a project' do
     subject { @projects.first}
     
@@ -28,7 +37,7 @@ describe Kickstapi do
     its(:pledged) { should be_kind_of Float }
     
     it "returns valid json" do
-      expect { JSON.parse @projects.first.to_json }.not_to raise_error 
+      expect { @projects.first.load; JSON.parse @projects.first.to_json }.not_to raise_error 
     end
 
     it "should be in ghost state when first fetched" do
@@ -66,7 +75,7 @@ describe Kickstapi do
     end
 
     it "should mark a successful project" do
-      @projects.first.status.should be_eql :succesful
+      @projects.first.status.should be_eql :successful
     end
 
     it "should mark an unsuccessful project" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kickstapi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Kristof Vannotten