gratitude 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702501d8e5569021fd461621963fe358ebd1f884
-  data.tar.gz: bce5748bcf60e3008309a34a43b11519291cdda9
+  metadata.gz: f98788dbd6abb9015c3714caf00069350d02015f
+  data.tar.gz: 321b4733b5987a3f46fe0f51b9efee0a0f242d79
 SHA512:
-  metadata.gz: 352f4798d33fccc21c119602c1b9f473592e0965e71a26cf47c36de38e62bc8033b2ae603eabfc664e4e970782f59a6c4e45870b0b0fa2f05c7e3a5117becbd3
-  data.tar.gz: 6d05accd6e7cfe014842a1b8e80c04b999dd6a477fbf7a20e150bafc10b59410fb92f2ae58fcf74bccc5b6e9c6d027e421ab48b85aae27f9c7d787212599afd2
+  metadata.gz: ba9b54097f32bcd2e898a19e97d7a2ddd3d5c576b8842777d42efbdd48dd62567d8043757ddeb5d31ac321f7533777736d4a75397c5e3f290d2ba93a9bee5a21
+  data.tar.gz: 175a691394abc0682d316ffd86e1aaab09c7ce12cf4fcf3aec96311963c781f684bf951fdb62bf1d8c6f1393bdc088e86a6791551cb79e6d87893dcb3a3df0fb

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ### 0.1.0 (Upcoming Stable Release)
 * Implement all aspects of the Gittip API.
 
+### 0.0.7 (10/13/2013)
+* Update documentation.
+* Alias new to current in Statistics class.
+
 ### 0.0.6 (9/19/2013)
 * Complete Gittip's Statistics API integration.
 * Add more aliases and improve method clarity to signify method intent.

data/README.md

@@ -149,11 +149,38 @@ The above will retrieve the public profile of the above user. You can then acces
 
 **TODO:** Implement the `my_tip` method into the Profile section once client authentication is finished.
 
-##Tips
-* **TODO:** Implement Gittip's Tips API into gratitude.
+##Tips ([client authentication source code](https://github.com/JohnKellyFerguson/gratitude/blob/master/lib/gratitude/client.rb), [tips source code](https://github.com/JohnKellyFerguson/gratitude/blob/master/lib/gratitude/tips.rb))
+The Tips aspect of the Gittip API allows you to retrieve the current tips of a user. In order to get this information, you will need your username and API_KEY. To find out your API Key, log into your Gittip account, go to your profile and at the bottom of the page you will find your API_KEY.
 
+![Gittip API Key](api_key.png)
 
-#### Copyright and License
+Now that you have your API_KEY, you can find out your current tips using Gratitude.
+
+```
+# First establish a connection to the Gittip API by passing in your credentials to Gratitude::Client.new
+# You will need to pass in your username and api key like so.
+client = Gratitude::Client.new(:username => "my_username", :api_key => "my_api_key")
+# Then, to find out your current tips, simply call the current_tips method.
+client.current_tips
+```
+This will will return an array of hashes that represent your current tips and will look similar to the following.
+
+
+    [
+      {"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
+      {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"},
+      …
+    ]
+
+Please be aware that all of the amounts in the hash are strings and not floats.
+
+
+
+* **TODO:** Add the ability to post and update tips to Gittip's API.
+
+
+
+### Copyright and License
 
 Copyright John Kelly Ferguson and Contributors, 2013
 

data/lib/gratitude/client.rb

@@ -0,0 +1,16 @@
+require "gratitude/tips"
+
+module Gratitude
+  class Client
+    include HTTParty
+    include Gratitude::Client::Tips
+
+    attr_reader :username, :api_key
+
+    def initialize(options = {})
+      @username = options[:username]
+      @api_key = options[:api_key]
+    end
+
+  end # Payday
+end # Gratitude

data/lib/gratitude/tips.rb

@@ -0,0 +1,19 @@
+module Gratitude
+  class Client
+    module Tips
+
+      def tips_url
+        "https://www.gittip.com/#{username}/tips.json"
+      end
+
+      def authorization
+        { :basic_auth => { :username => api_key } }
+      end
+
+      def current_tips
+        self.class.get(tips_url, authorization).parsed_response
+      end
+
+    end # Tips
+  end # Client
+end # Gratitude

data/lib/gratitude/version.rb

@@ -1,3 +1,3 @@
 module Gratitude
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/gratitude.rb

@@ -1,11 +1,12 @@
 require "httparty"
 
-
+require "gratitude/client"
 require "gratitude/payday"
 require "gratitude/profile"
 require "gratitude/statistics"
+require "gratitude/tips"
 require "gratitude/version"
 
+
 module Gratitude
-  # Your code goes here...
 end

data/spec/cassettes/tips.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2:@www.gittip.com/gratitude_test/tips.json","body":{"encoding":"US-ASCII","string":""},"headers":{}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Content-Type":["application/json"],"Date":["Tue, 15 Oct 2013 19:26:37 GMT"],"Expires":["Thu, 01 Jan 1970 00:00:00 GMT"],"Server":["Aspen! Cheroot!"],"Set-Cookie":["csrf_token=nuo6OY6TglUcv9JyVD316bT5VDsTywEL; expires=Tue, 14 Oct 2014 19:26:37 GMT; Path=/","session=c08eaad1dae3407c9d31f5ca904364bd; expires=Tue, 22 Oct 2013 19:26:36 GMT; httponly; Path=/; secure"],"Vary":["Cookie"],"X-Frame-Options":["SAMEORIGIN"],"X-Gittip-Version":["10.1.33"],"Transfer-Encoding":["chunked"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"[\n    {\n        \"amount\": \"1.00\",\n        \"platform\": \"gittip\",\n        \"username\": \"whit537\"\n    },\n    {\n        \"amount\": \"0.25\",\n        \"platform\": \"gittip\",\n        \"username\": \"JohnKellyFerguson\"\n    }\n]"},"http_version":null},"recorded_at":"Tue, 15 Oct 2013 19:26:37 GMT"}],"recorded_with":"VCR 2.5.0"}

data/spec/gratitude/client_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe Gratitude::Client do
+
+  describe "default attributes" do
+
+    it "should include httparty methods" do
+      Gratitude::Client.should include(HTTParty)
+    end
+
+    it "should include tips methods" do
+      Gratitude::Client.should include(Gratitude::Client::Tips)
+    end
+
+  end # default attributes
+
+  describe "initialization" do
+    let(:username) { "JohnKellyFerguson"}
+    let(:api_key) { "this_is_an_api_key"}
+
+    subject { Gratitude::Client.new(:username => username, :api_key => api_key) }
+
+    its(:username) { should == username }
+    its(:api_key) { should == api_key }
+
+  end
+
+
+end

data/spec/gratitude/tips_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe Gratitude::Client::Tips do
+
+  let(:username) { "gratitude_test" }
+  let(:api_key) { "5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2" }
+
+  let(:client) { Gratitude::Client.new(:username => username, :api_key => api_key) }
+
+  describe "#tips_url" do
+    it "returns the correct tips_url" do
+      expect(client.tips_url).to eq("https://www.gittip.com/gratitude_test/tips.json")
+    end
+  end
+
+  describe "#authorization" do
+    it "returns the correct authorization hash" do
+      expect(client.authorization).to eq({ :basic_auth => { :username =>  api_key } })
+    end
+  end
+
+
+  describe "authentication and api requests" do
+
+    let(:current_tips) { [{"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
+                          {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}] }
+
+    before do
+      VCR.insert_cassette "tips"
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe "#current_tips" do
+      it "returns the correct array of current tips" do
+        expect(client.current_tips).to eq (current_tips)
+      end
+    end
+
+    describe "#update_tip" do
+    end
+
+    describe "#update_tips" do
+    end
+
+    describe "#update_tips_and_prune" do
+    end
+
+
+  end # authentication and api requests
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gratitude
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - John Kelly Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -67,20 +67,26 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- api_key.png
 - gratitude.gemspec
 - lib/gratitude.rb
+- lib/gratitude/client.rb
 - lib/gratitude/payday.rb
 - lib/gratitude/profile.rb
 - lib/gratitude/statistics.rb
+- lib/gratitude/tips.rb
 - lib/gratitude/version.rb
 - spec/cassettes/complete_profile.json
 - spec/cassettes/goal_profile.json
 - spec/cassettes/incomplete_profile.json
 - spec/cassettes/paydays.json
 - spec/cassettes/statistics.json
+- spec/cassettes/tips.json
+- spec/gratitude/client_spec.rb
 - spec/gratitude/payday_spec.rb
 - spec/gratitude/profile_spec.rb
 - spec/gratitude/statistics_spec.rb
+- spec/gratitude/tips_spec.rb
 - spec/gratitude/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/JohnKellyFerguson/gratitude
@@ -113,8 +119,11 @@ test_files:
 - spec/cassettes/incomplete_profile.json
 - spec/cassettes/paydays.json
 - spec/cassettes/statistics.json
+- spec/cassettes/tips.json
+- spec/gratitude/client_spec.rb
 - spec/gratitude/payday_spec.rb
 - spec/gratitude/profile_spec.rb
 - spec/gratitude/statistics_spec.rb
+- spec/gratitude/tips_spec.rb
 - spec/gratitude/version_spec.rb
 - spec/spec_helper.rb