gratitude 0.0.12 → 0.1.0

data/spec/gratitude/profile_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Gratitude::Profile do
@@ -9,6 +11,13 @@ describe Gratitude::Profile do
   end
 
   describe "instance methods" do
+    context "when the requested Gittip user does not exist" do
+      it "raises a UsernameNotFoundError" do
+        expect { Gratitude::Profile.new("non_existing_user").send(:response) }
+          .to raise_error(Gratitude::UsernameNotFoundError)
+      end
+    end
+
     before { VCR.insert_cassette "profiles" }
     after { VCR.eject_cassette }
     let(:complete_profile) { Gratitude::Profile.new("JohnKellyFerguson") }
@@ -23,19 +32,19 @@ describe Gratitude::Profile do
       it "returns the correct keys in the json hash" do
         expect(complete_profile.send(:response_body).keys)
           .to eq(
-            [
-              "avatar",
-              "bitcoin",
-              "elsewhere",
-              "giving",
-              "goal",
-              "id",
-              "npatrons",
-              "number",
-              "on",
-              "receiving",
-              "username"
-              ]
+            %w(
+              avatar
+              bitcoin
+              elsewhere
+              giving
+              goal
+              id
+              npatrons
+              number
+              on
+              receiving
+              username
+              )
             )
       end
     end

data/spec/gratitude/statistics_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Gratitude::Statistics do
@@ -17,27 +19,27 @@ describe Gratitude::Statistics do
       it "returns the correct keys in the json hash" do
         expect(stats.send(:response_body).keys)
           .to eq(
-            [
-              "average_tip",
-              "average_tippees",
-              "escrow",
-              "last_thursday",
-              "nach",
-              "nactive",
-              "ncc",
-              "ngivers",
-              "noverlap",
-              "nreceivers",
-              "other_people",
-              "pcc",
-              "punc",
-              "statements",
-              "this_thursday",
-              "tip_distribution_json",
-              "tip_n",
-              "total_backed_tips",
-              "transfer_volume"
-              ]
+            %w(
+              average_tip
+              average_tippees
+              escrow
+              last_thursday
+              nach
+              nactive
+              ncc
+              ngivers
+              noverlap
+              nreceivers
+              other_people
+              pcc
+              punc
+              statements
+              this_thursday
+              tip_distribution_json
+              tip_n
+              total_backed_tips
+              transfer_volume
+              )
           )
       end
     end
@@ -183,13 +185,13 @@ describe Gratitude::Statistics do
 
       it "has statement as a key in each hash element" do
         stats.statements.each do |statement|
-          expect(statement.has_key?("statement")).to be(true)
+          expect(statement.key?("statement")).to be(true)
         end
       end
 
       it "has username as a key in each hash element" do
         stats.statements.each do  |statement|
-          expect(statement.has_key?("username")).to be(true)
+          expect(statement.key?("username")).to be(true)
         end
       end
     end

data/spec/gratitude/tips_spec.rb

@@ -1,77 +1,214 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Gratitude::Client::Tips do
   let(:username) { "gratitude_test" }
   let(:api_key) { "5962b93a-5bf7-4cb6-ae6f-aa4114c5e4f2" }
   let(:client) do
-    Gratitude::Client.new(:username => username, :api_key => api_key)
+    Gratitude::Client.new(username: username, api_key: api_key)
+  end
+  let(:unauthenticated_client) do
+    Gratitude::Client.new(username: username, api_key: "bad_key")
+  end
+  let(:current_tips) do
+    [
+      { "amount" => "1.00",
+        "platform" => "gittip",
+        "username" => "whit537"
+      },
+      { "amount" => "0.25",
+        "platform" => "gittip",
+        "username" => "JohnKellyFerguson"
+      }
+    ]
   end
 
   describe "GET Requests" do
-    before { VCR.insert_cassette "current_tips" }
-    after { VCR.eject_cassette }
-    let(:current_tips) do
-      [
-        {"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
-        {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}
-      ]
-    end
-
     describe "#current_tips" do
-      it "returns the correct array of current tips" do
-        expect(client.current_tips).to eq (current_tips)
+      context "when properly authenticated" do
+        before { VCR.insert_cassette "current_tips" }
+        before { client.update_tips(current_tips) }
+        after { VCR.eject_cassette }
+        it "returns the correct array of current tips" do
+          expect(client.current_tips).to eq(current_tips)
+        end
+      end
+
+      context "when not properly authenticated" do
+        before { VCR.insert_cassette "current_tips_not_authenticated" }
+        after { VCR.eject_cassette }
+
+        it "raises an AuthenticationError" do
+          expect { unauthenticated_client.current_tips }
+            .to raise_error(Gratitude::AuthenticationError)
+        end
       end
     end
 
     describe "#current_tips_total" do
+      before { VCR.insert_cassette "current_tips" }
+      after { VCR.eject_cassette }
+
       it "returns the correct total of current tips" do
         expect(client.current_tips_total).to eq(1.25)
       end
     end
-  end #GET Requests
+  end # GET Requests
 
   describe "POST Requests" do
     describe "#update_tips" do
-      before { VCR.insert_cassette "update_tips" }
-      after { VCR.eject_cassette }
-
       let(:multiple_tips) do
         [
-          {"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
-          {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"},
-          {"amount"=>"1.00", "platform"=>"gittip", "username"=>"Gittip"}
+          { "amount" => "1.00",
+            "platform" => "gittip",
+            "username" => "whit537"
+          },
+          { "amount" => "0.25",
+            "platform" => "gittip",
+            "username" => "JohnKellyFerguson"
+          },
+          {
+            "amount" => "1.00",
+            "platform" => "gittip",
+            "username" => "Gittip"
+          }
         ]
       end
 
-      it "updates the correct tip information" do
-        expect(client.update_tips(multiple_tips)).to eq(multiple_tips)
+      context "when not properly authenticated" do
+        before { VCR.insert_cassette "update_tips_not_authenticated" }
+        after { VCR.eject_cassette }
+
+        it "raises an AuthenticationError" do
+          expect { unauthenticated_client.update_tips(multiple_tips) }
+            .to raise_error(Gratitude::AuthenticationError)
+        end
       end
-    end #update_tips
 
-    describe "#update_tips_and_prune" do
-      before { VCR.insert_cassette "update_and_prune" }
-      after { VCR.eject_cassette }
+      context "when there are bad request parameters" do
+        before { VCR.insert_cassette "update_bad_request" }
+        after { VCR.eject_cassette }
+        let(:incorrect_tips) do
+          [
+            {
+              "amount" => "1.00",
+              "platform" => "gittip",
+              "username" => "not_a_user_so_fake"
+            },
+            {
+              "amount" => "0.25",
+              "platform" => "gittip",
+              "username" => "lol_this_will_be_an_error"
+            },
+            {
+              "amount" => "1.00",
+              "platform" => "gittip",
+              "username" => "whit537"
+            },
+            {
+              "amount" => "0.25",
+              "platform" => "gittip",
+              "username" => "JohnKellyFerguson"
+            }
+          ]
+        end
 
-      let(:previous_tips) do
-        [
-          {"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
-          {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"},
-          {"amount"=>"1.00", "platform"=>"gittip", "username"=>"Gittip"}
-        ]
+        it "raises a TipUpdateError" do
+          expect { client.update_tips(incorrect_tips) }
+            .to raise_error(Gratitude::TipUpdateError)
+        end
+      end
+
+      context "when properly authenticated" do
+        before { VCR.insert_cassette "update_tips" }
+        after { VCR.eject_cassette }
+
+        it "updates the correct tip information" do
+          expect(client.update_tips(multiple_tips)).to eq(multiple_tips)
+        end
       end
+    end # update_tips
+
+    describe "#update_tips_and_prune" do
       let(:pruned_tips) do
         [
-          {"amount"=>"1.00", "platform"=>"gittip", "username"=>"whit537"},
-          {"amount"=>"0.25", "platform"=>"gittip", "username"=>"JohnKellyFerguson"}
+          {
+            "amount" => "1.00",
+            "platform" => "gittip",
+            "username" => "whit537"
+          },
+          {
+            "amount" => "0.25",
+            "platform" => "gittip",
+            "username" => "JohnKellyFerguson"
+          }
         ]
       end
 
-      it "removes tips that were not part of the request" do
-        expect { client.update_tips_and_prune(pruned_tips) }
-          .to change { client.current_tips }
-          .to(pruned_tips)
+      context "when properly authenticated" do
+        before { VCR.insert_cassette "update_and_prune" }
+        after { VCR.eject_cassette }
+        let(:previous_tips) do
+          [
+            {
+              "amount" => "1.00",
+              "platform" => "gittip",
+              "username" => "Gittip"
+            },
+            {
+              "amount" => "1.00",
+              "platform" => "gittip",
+              "username" => "whit537"
+            },
+            {
+              "amount" => "0.25",
+              "platform" => "gittip",
+              "username" => "JohnKellyFerguson"
+            }
+          ]
+        end
+
+        it "removes tips that were not part of the request" do
+          expect { client.update_tips_and_prune(pruned_tips) }
+            .to change { client.current_tips }
+            .from(previous_tips)
+            .to(pruned_tips)
+        end
+      end
+
+      context "when there are bad request parameters" do
+        before { VCR.insert_cassette "update_and_prune_bad_request" }
+        after { VCR.eject_cassette }
+        let(:incorrect_tips) do
+          [
+            { "amount" => "1.00",
+              "platform" => "gittip",
+              "username" => "not_a_user_so_fake"
+            },
+            {
+              "amount" => "0.25",
+              "platform" => "gittip",
+              "username" => "will_be_an_error"
+            }
+          ]
+        end
+
+        it "raises a TipUpdateError" do
+          expect { client.update_tips_and_prune(incorrect_tips) }
+            .to raise_error(Gratitude::TipUpdateError)
+        end
       end
-    end
 
-  end #POST Requests
-end
+      context "when not properly authenticated" do
+        before { VCR.insert_cassette "prune_tips_not_authenticated" }
+        after { VCR.eject_cassette }
+
+        it "raises an AuthenticationError" do
+          expect { unauthenticated_client.update_tips_and_prune(pruned_tips) }
+            .to raise_error(Gratitude::AuthenticationError)
+        end
+      end
+    end
+  end # POST Requests
+end

data/spec/gratitude/user_chart_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Gratitude::UserChart do
@@ -22,30 +24,42 @@ describe Gratitude::UserChart do
           .to be(Array)
       end
 
-      it "updates the USER_CHARTS constant when it is empty" do
-        expect { Gratitude::UserChart.all_for_user("Gittip") }
-          .to change { Gratitude::UserChart::USER_CHARTS.size }.from(0)
-      end
+      context "when the requested Gittip user exists" do
+        it "updates the USER_CHARTS constant when it is empty" do
+          expect { Gratitude::UserChart.all_for_user("Gittip") }
+            .to change { Gratitude::UserChart::USER_CHARTS.size }.from(0)
+        end
+
+        it "its array should be comprised of User_Chart objects" do
+          Gratitude::UserChart.all_for_user("Gittip").each do |user_chart|
+            expect(user_chart.class).to eq(Gratitude::UserChart)
+          end
+        end
 
-      it "its array should be comprised of User_Chart objects" do
-        Gratitude::UserChart.all_for_user("Gittip").each do |user_chart|
-          expect(user_chart.class).to eq(Gratitude::UserChart)
+        it "only includes charts for a given username" do
+          Gratitude::UserChart.all_for_user("whit537")
+          Gratitude::UserChart.all_for_user("Gittip").each do |user_chart|
+            expect(user_chart.username).to eq("Gittip")
+          end
         end
       end
 
-      it "only includes charts for a given username" do
-        Gratitude::UserChart.all_for_user("whit537")
-        Gratitude::UserChart.all_for_user("Gittip").each do |user_chart|
-          expect(user_chart.username).to eq("Gittip")
+      context "when the requested Gittip user does not exist" do
+        before { VCR.insert_cassette "user_chart_not_found" }
+        after { VCR.eject_cassette }
+
+        it "raises a UsernameNotFoundError" do
+          expect { Gratitude::UserChart.all_for_user("non_existing_user") }
+            .to raise_error(Gratitude::UsernameNotFoundError)
         end
       end
     end
 
-
     describe "#sort_by_date_for_user" do
       it "places the newest user chart before the oldest user chart" do
         expect(Gratitude::UserChart.sort_by_date_for_user("Gittip").first.date)
-          .to be > (Gratitude::UserChart.sort_by_date_for_user("Gittip").last.date)
+          .to be >
+            (Gratitude::UserChart.sort_by_date_for_user("Gittip").last.date)
       end
     end
 
@@ -63,21 +77,20 @@ describe Gratitude::UserChart do
       end
     end
   end
+
   describe "initialization and instance methods" do
 
     it "adds the initialized object to the CHARTS constant" do
-      expect { Gratitude::UserChart.new() }
-        .to change{ Gratitude::UserChart::USER_CHARTS.size }.by(1)
+      expect { Gratitude::UserChart.new }
+        .to change { Gratitude::UserChart::USER_CHARTS.size }.by(1)
     end
 
     let(:user_chart) do
       Gratitude::UserChart.new(
-        {
           "username" => "Gittip",
           "date" => "2014-03-27",
           "npatrons" => 137,
           "receipts" => 416.94
-        }
       )
     end
 

data/spec/gratitude/version_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 
 describe Gratitude do

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 # Coveralls
-require 'coveralls'
+require "coveralls"
 Coveralls.wear!
 
 # dependencies
@@ -13,8 +15,8 @@ require "webmock"
 
 # VCR config
 VCR.configure do |c|
-  c.cassette_library_dir = 'spec/cassettes'
+  c.cassette_library_dir = "spec/cassettes"
   c.hook_into :webmock
   c.default_cassette_options = { record: :new_episodes, serialize_with: :json }
-  c.default_cassette_options = { re_record_interval: 604800 }
+  c.default_cassette_options = { re_record_interval: 604_800 }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gratitude
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.1.0
 platform: ruby
 authors:
 - John Kelly Ferguson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-31 00:00:00.000000000 Z
+date: 2014-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -88,9 +88,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -102,6 +105,7 @@ files:
 - lib/gratitude/chart.rb
 - lib/gratitude/client.rb
 - lib/gratitude/connection.rb
+- lib/gratitude/error.rb
 - lib/gratitude/payday.rb
 - lib/gratitude/profile.rb
 - lib/gratitude/statistics.rb
@@ -110,11 +114,17 @@ files:
 - lib/gratitude/version.rb
 - spec/cassettes/charts.json
 - spec/cassettes/current_tips.json
+- spec/cassettes/current_tips_not_authenticated.json
 - spec/cassettes/paydays.json
 - spec/cassettes/profiles.json
+- spec/cassettes/prune_tips_not_authenticated.json
 - spec/cassettes/statistics.json
 - spec/cassettes/update_and_prune.json
+- spec/cassettes/update_and_prune_bad_request.json
+- spec/cassettes/update_bad_request.json
 - spec/cassettes/update_tips.json
+- spec/cassettes/update_tips_not_authenticated.json
+- spec/cassettes/user_chart_not_found.json
 - spec/cassettes/user_charts.json
 - spec/gratitude/chart_spec.rb
 - spec/gratitude/client_spec.rb
@@ -153,11 +163,17 @@ summary: A simple Ruby wrapper for the Gittip API.
 test_files:
 - spec/cassettes/charts.json
 - spec/cassettes/current_tips.json
+- spec/cassettes/current_tips_not_authenticated.json
 - spec/cassettes/paydays.json
 - spec/cassettes/profiles.json
+- spec/cassettes/prune_tips_not_authenticated.json
 - spec/cassettes/statistics.json
 - spec/cassettes/update_and_prune.json
+- spec/cassettes/update_and_prune_bad_request.json
+- spec/cassettes/update_bad_request.json
 - spec/cassettes/update_tips.json
+- spec/cassettes/update_tips_not_authenticated.json
+- spec/cassettes/user_chart_not_found.json
 - spec/cassettes/user_charts.json
 - spec/gratitude/chart_spec.rb
 - spec/gratitude/client_spec.rb