gratitude 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98788dbd6abb9015c3714caf00069350d02015f
-  data.tar.gz: 321b4733b5987a3f46fe0f51b9efee0a0f242d79
+  metadata.gz: 6612f9265596c16760a8a6a57cdf792de502ac33
+  data.tar.gz: 2c3fd5e87e85e5797264db76467312616129bb3c
 SHA512:
-  metadata.gz: ba9b54097f32bcd2e898a19e97d7a2ddd3d5c576b8842777d42efbdd48dd62567d8043757ddeb5d31ac321f7533777736d4a75397c5e3f290d2ba93a9bee5a21
-  data.tar.gz: 175a691394abc0682d316ffd86e1aaab09c7ce12cf4fcf3aec96311963c781f684bf951fdb62bf1d8c6f1393bdc088e86a6791551cb79e6d87893dcb3a3df0fb
+  metadata.gz: 3508b34b260ee22ad4baeb21b8db6fe09cef53082d493841f5224c4ff8d895dd5f43477ded0eb7b8c352d2876cf048e6f672a2b11188a31a0eaf20ec891053cb
+  data.tar.gz: ba4d68e325ea9730e3cf2429a56a69cbe6a2e8ef9ae6272065de1bce026d9aed0d4296a19c05ebf0cb3eda506d563a6322c73c3dd6dc4d436c43a902968da5c0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ### 0.1.0 (Upcoming Stable Release)
 * Implement all aspects of the Gittip API.
 
+### 0.0.8 (10/18/2013)
+* Add client authentication.
+* Add ability to retrieve a user's current tips.
+
 ### 0.0.7 (10/13/2013)
 * Update documentation.
 * Alias new to current in Statistics class.

data/README.md

@@ -9,7 +9,7 @@ gratitude
 
 A simple Ruby wrapper for the [Gittip API](https://github.com/gittip/www.gittip.com#api).
 
-**Note**: This gem is currently under development and is not ready for use in a production environment. A stable version is planned for v0.1.0. Please follow the [Changelog](CHANGELOG.md) to check the status of the project.
+**Note**: This gem is currently under development. A feature complete version that implements all features of the original Gittip API is planned for v0.1.0. Please follow the [Changelog](CHANGELOG.md) to check the status of the project.
 
 
 # Installation

data/gratitude.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "httparty", "~> 0.11"
+  spec.add_dependency "json"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/gratitude/tips.rb

@@ -2,16 +2,53 @@ module Gratitude
   class Client
     module Tips
 
+      def current_tips
+        self.class.get(tips_url, { :basic_auth => authorization }).parsed_response
+      end
+
+      def current_tips_total
+        current_tips.inject(0) { |total, tip| total + tip["amount"].to_f }
+      end
+
+      def update_tips(array_of_hashes_with_usernames_and_amounts)
+        self.class.post(tips_url,
+        {
+          :body => prepared_tips_array(array_of_hashes_with_usernames_and_amounts).to_json,
+          :basic_auth => authorization,
+          :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'}
+          })
+      end
+
+      def update_tips_and_prune(array_of_hashes_with_usernames_and_amounts)
+        self.class.post(tips_url,
+        {
+          :body => prepared_tips_array(array_of_hashes_with_usernames_and_amounts).to_json,
+          :basic_auth => authorization,
+          :query => { :also_prune => "true"},
+          :headers => { 'Content-Type' => 'application/json', 'Accept' => 'application/json'}
+          })
+      end
+
       def tips_url
         "https://www.gittip.com/#{username}/tips.json"
       end
 
       def authorization
-        { :basic_auth => { :username => api_key } }
+        { :username => api_key }
       end
 
-      def current_tips
-        self.class.get(tips_url, authorization).parsed_response
+      def tip_hash_based_upon(username, amount)
+        { "amount" => "#{amount}", "platform" => "gittip", "username" => "#{username}" }
+      end
+
+      def prepared_tips_array(array_of_hashes_with_usernames_and_amounts)
+        prepared_array = []
+        array_of_hashes_with_usernames_and_amounts.each do |hash|
+          username = hash[:username] || hash["username"]
+          amount = hash[:amount] || hash["amount"]
+          prepared_array << tip_hash_based_upon(username, amount)
+        end
+        prepared_array
       end
 
     end # Tips

data/lib/gratitude/version.rb

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

data/spec/cassettes/get_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":["Sun, 20 Oct 2013 01:41:31 GMT"],"Expires":["Thu, 01 Jan 1970 00:00:00 GMT"],"Server":["Aspen! Cheroot!"],"Set-Cookie":["csrf_token=qJFOtxb2kGqZhrlXEv5QRrLcP3H0wik9; expires=Sun, 19 Oct 2014 01:41:31 GMT; Path=/","session=c08eaad1dae3407c9d31f5ca904364bd; expires=Sun, 27 Oct 2013 01:41:31 GMT; httponly; Path=/; secure"],"Vary":["Cookie"],"X-Frame-Options":["SAMEORIGIN"],"X-Gittip-Version":["10.1.35"],"Content-Length":["210"],"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":"Sun, 20 Oct 2013 01:41:36 GMT"}],"recorded_with":"VCR 2.5.0"}

data/spec/cassettes/post_multiple_tips.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"post","uri":"https://5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2:@www.gittip.com/gratitude_test/tips.json","body":{"encoding":"UTF-8","string":"[{\"amount\":\"10\",\"platform\":\"gittip\",\"username\":\"whit537\"},{\"amount\":\"4\",\"platform\":\"gittip\",\"username\":\"JohnKellyFerguson\"}]"},"headers":{"Content-Type":["application/json"],"Accept":["application/json"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Content-Type":["application/json"],"Date":["Sun, 20 Oct 2013 03:12:30 GMT"],"Expires":["Thu, 01 Jan 1970 00:00:00 GMT"],"Server":["Aspen! Cheroot!"],"Set-Cookie":["csrf_token=zpQWN7H1DlHpCQvAB9mPs7aMjXroYDOV; expires=Sun, 19 Oct 2014 03:12:30 GMT; Path=/","session=c08eaad1dae3407c9d31f5ca904364bd; expires=Sun, 27 Oct 2013 03:12:30 GMT; httponly; Path=/; secure"],"Vary":["Cookie"],"X-Frame-Options":["SAMEORIGIN"],"X-Gittip-Version":["10.1.35"],"Content-Length":["205"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"[\n    {\n        \"amount\": \"10\",\n        \"platform\": \"gittip\",\n        \"username\": \"whit537\"\n    },\n    {\n        \"amount\": \"4\",\n        \"platform\": \"gittip\",\n        \"username\": \"JohnKellyFerguson\"\n    }\n]"},"http_version":null},"recorded_at":"Sun, 20 Oct 2013 03:12:37 GMT"}],"recorded_with":"VCR 2.5.0"}

data/spec/cassettes/post_single_tip.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"post","uri":"https://5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2:@www.gittip.com/gratitude_test/tips.json","body":{"encoding":"UTF-8","string":"[{\"amount\":\"5\",\"platform\":\"gittip\",\"username\":\"whit537\"}]"},"headers":{"Content-Type":["application/json"],"Accept":["application/json"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Content-Type":["application/json"],"Date":["Sun, 20 Oct 2013 03:09:02 GMT"],"Expires":["Thu, 01 Jan 1970 00:00:00 GMT"],"Server":["Aspen! Cheroot!"],"Set-Cookie":["csrf_token=DRdyOGvuZo1D9zPRfgzXAbhOpQrP03Na; expires=Sun, 19 Oct 2014 03:09:02 GMT; Path=/","session=c08eaad1dae3407c9d31f5ca904364bd; expires=Sun, 27 Oct 2013 03:09:02 GMT; httponly; Path=/; secure"],"Vary":["Cookie"],"X-Frame-Options":["SAMEORIGIN"],"X-Gittip-Version":["10.1.35"],"Content-Length":["98"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"[\n    {\n        \"amount\": \"5\",\n        \"platform\": \"gittip\",\n        \"username\": \"whit537\"\n    }\n]"},"http_version":null},"recorded_at":"Sun, 20 Oct 2013 03:09:09 GMT"}],"recorded_with":"VCR 2.5.0"}

data/spec/cassettes/post_tip_error.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"post","uri":"https://5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2:@www.gittip.com/gratitude_test/tips.json","body":{"encoding":"UTF-8","string":"[{\"amount\":\"20\",\"platform\":\"gittip\",\"username\":\"not_a_real_user\"}]"},"headers":{"Content-Type":["application/json"],"Accept":["application/json"]}},"response":{"status":{"code":200,"message":"OK"},"headers":{"Content-Type":["application/json"],"Date":["Sun, 20 Oct 2013 03:21:36 GMT"],"Expires":["Thu, 01 Jan 1970 00:00:00 GMT"],"Server":["Aspen! Cheroot!"],"Set-Cookie":["csrf_token=iyQSAZVfmuWKaWltmYauK2Jadl8oCunm; expires=Sun, 19 Oct 2014 03:21:36 GMT; Path=/","session=c08eaad1dae3407c9d31f5ca904364bd; expires=Sun, 27 Oct 2013 03:21:36 GMT; httponly; Path=/; secure"],"Vary":["Cookie"],"X-Frame-Options":["SAMEORIGIN"],"X-Gittip-Version":["10.1.35"],"Content-Length":["141"],"Connection":["keep-alive"]},"body":{"encoding":"UTF-8","string":"[\n    {\n        \"amount\": \"e\",\n        \"error\": \"IntegrityError\",\n        \"platform\": \"gittip\",\n        \"username\": \"not_a_real_user\"\n    }\n]"},"http_version":null},"recorded_at":"Sun, 20 Oct 2013 03:21:43 GMT"}],"recorded_with":"VCR 2.5.0"}

data/spec/gratitude/tips_spec.rb

@@ -7,47 +7,181 @@ describe Gratitude::Client::Tips do
 
   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")
+  describe "methods that do not interact with the API" do
+
+    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
-  end
 
-  describe "#authorization" do
-    it "returns the correct authorization hash" do
-      expect(client.authorization).to eq({ :basic_auth => { :username =>  api_key } })
+    describe "#authorization" do
+      it "returns the correct authorization hash" do
+        expect(client.authorization).to eq({ :username =>  api_key })
+      end
     end
-  end
 
+    describe "#tip_hash_based_upon(username, amount)" do
+      it "returns the correct tip hash when given an integer" do
+        expect(client.tip_hash_based_upon("whit537", 1)).to eq(
+          { "amount" => "1", "platform" => "gittip", "username" => "whit537" })
+      end
 
-  describe "authentication and api requests" do
+      it "returns the correct tip hash when given an integer in a string" do
+        expect(client.tip_hash_based_upon("whit537", "1")).to eq(
+          { "amount" => "1", "platform" => "gittip", "username" => "whit537" })
+      end
 
-    let(:current_tips) { [{"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
-                          {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}] }
+      it "returns the correct tip hash when given a float" do
+        expect(client.tip_hash_based_upon("whit537", 0.25)).to eq(
+          { "amount" => "0.25", "platform" => "gittip", "username" => "whit537" })
+      end
 
-    before do
-      VCR.insert_cassette "tips"
-    end
+      it "returns the correct tip hash when given a float" do
+        expect(client.tip_hash_based_upon("whit537", "0.25")).to eq(
+          { "amount" => "0.25", "platform" => "gittip", "username" => "whit537" })
+      end
+    end #single_tip_hash
+
+
+    describe "#tips_array" do
+
+      context "when using symbols as keys" do
+        it "returns the correct tips array when given an array with one tip" do
+          expect(client.prepared_tips_array([:username => "whit537", :amount => "1"])).to eq(
+            [{ "amount" => "1", "platform" => "gittip", "username" => "whit537" }])
+        end
+
+        it "returns the correct tips array when given an array with two tips" do
+          expect(client.prepared_tips_array([
+            { :username => "whit537", :amount => "1" },
+            { :username => "JohnKellyFerguson", :amount => "0.25" }
+          ])).to eq([
+            { "amount" => "1", "platform" => "gittip", "username" => "whit537" },
+            { "amount" => "0.25", "platform" => "gittip", "username" => "JohnKellyFerguson" }
+            ])
+        end
+      end # symbols as keys
+
+      context "when using strings as keys" do
+        it "returns the correct tips array when given an array with one tip" do
+          expect(client.prepared_tips_array(["username" => "whit537", "amount" => "1"])).to eq(
+            [{ "amount" => "1", "platform" => "gittip", "username" => "whit537" }])
+        end
+
+        it "returns the correct tips array when given an array with one tip" do
+              expect(client.prepared_tips_array([
+                { "username" => "whit537", "amount" => "1" },
+                { "username" => "JohnKellyFerguson", "amount" => "0.25" }
+              ])).to eq([
+                { "amount" => "1", "platform" => "gittip", "username" => "whit537" },
+                { "amount" => "0.25", "platform" => "gittip", "username" => "JohnKellyFerguson" }
+                ])
+        end
+      end # strings as keys
+
+    end #tips_array
+
+  end # methods that do not interact with the API
 
-    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)
+  describe "authentication and api requests" do
+
+    context "GET Requests" do
+      let(:current_tips) { [{"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
+                            {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}] }
+
+      before do
+        VCR.insert_cassette "get_tips"
       end
-    end
 
-    describe "#update_tip" do
-    end
+      after do
+        VCR.eject_cassette
+      end
 
-    describe "#update_tips" do
-    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_tips_and_prune" do
-    end
+      describe "#current_tips_total" do
+        it "returns the correct total of current tips" do
+          expect(client.current_tips_total).to eq(1.25)
+        end
+      end
+    end #GET Requests
+
+    context "POST Requests" do
+
+      describe "#update_tips" do
+
+        context "when updating a single tip" do
+          let(:single_tip_response) { [{"amount"=>"5", "platform"=>"gittip", "username"=>"whit537"}] }
+
+          before do
+            VCR.insert_cassette "post_single_tip"
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it "updates the correct tip information" do
+            expect(
+              client.update_tips(
+                [{ :username => "whit537", :amount => "5" }]
+                ).parsed_response).to eq(single_tip_response)
+          end
+        end #updating a single tip
+
+        context "when updating multiple tips" do
+          let(:multi_tip_response) { [
+                                      {"amount"=>"10", "platform"=>"gittip", "username"=>"whit537"},
+                                      {"amount"=>"4", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}
+                                      ] }
+
+          before do
+            VCR.insert_cassette "post_multiple_tips"
+          end
+
+          after do
+            VCR.eject_cassette
+          end
+
+          it "updates the correct tip information" do
+            expect(
+              client.update_tips(
+                [{ :username => "whit537", :amount => "10" },
+                 { :username => "JohnKellyFerguson", :amount => "4"}]
+                ).parsed_response).to eq(multi_tip_response)
+          end
+        end # updating multiple tips
+
+        # context "when passing in a non-existent username" do
+        #   before do
+        #     VCR.insert_cassette "post_tip_error"
+        #   end
+
+        #   after do
+        #     VCR.eject_cassette
+        #   end
+
+        #   it "raises an error" do
+        #     expect(
+        #       client.update_tips(
+        #         [ {:username => "not_a_real_user", :amount => "20"} ]
+        #         ).parsed_response).to eq()
+        #   end
+        # end # non-existent username
+
+      end #update_tips
+
+      describe "#update_tips_and_prune" do
+
+      end
 
+    end #POST Requests
 
   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.8
+  version: 0.0.9
 platform: ruby
 authors:
 - John Kelly Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2013-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,11 +91,14 @@ files:
 - lib/gratitude/tips.rb
 - lib/gratitude/version.rb
 - spec/cassettes/complete_profile.json
+- spec/cassettes/get_tips.json
 - spec/cassettes/goal_profile.json
 - spec/cassettes/incomplete_profile.json
 - spec/cassettes/paydays.json
+- spec/cassettes/post_multiple_tips.json
+- spec/cassettes/post_single_tip.json
+- spec/cassettes/post_tip_error.json
 - spec/cassettes/statistics.json
-- spec/cassettes/tips.json
 - spec/gratitude/client_spec.rb
 - spec/gratitude/payday_spec.rb
 - spec/gratitude/profile_spec.rb
@@ -115,11 +132,14 @@ specification_version: 4
 summary: A simple Ruby wrapper for the Gittip API.
 test_files:
 - spec/cassettes/complete_profile.json
+- spec/cassettes/get_tips.json
 - spec/cassettes/goal_profile.json
 - spec/cassettes/incomplete_profile.json
 - spec/cassettes/paydays.json
+- spec/cassettes/post_multiple_tips.json
+- spec/cassettes/post_single_tip.json
+- spec/cassettes/post_tip_error.json
 - spec/cassettes/statistics.json
-- spec/cassettes/tips.json
 - spec/gratitude/client_spec.rb
 - spec/gratitude/payday_spec.rb
 - spec/gratitude/profile_spec.rb

data/spec/cassettes/tips.json

@@ -1 +0,0 @@
-{"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"}