gratitude 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffc3713c76d9bbaf8b996d658097995633479774
-  data.tar.gz: 6eaa284ea1160a9b40828c5c6d5bed069949f192
+  metadata.gz: 86d7979838448df774b9bd29f73c6b11e468c914
+  data.tar.gz: cceea1e613fe4789536d8e91865edbc42e7efbed
 SHA512:
-  metadata.gz: 8acf19c5e719aec6737e74726ef77e60b5c635d5c81906603f8e708db4a04a0e60848547e5c59f6d640a7bd26e061bec81bed112e88109647d4097d5a3aa836e
-  data.tar.gz: 5ae98a6fe09778768cfd6d1ff498b71958421e0a842324781ea9f56f4f80146ee61cfcf0f832f2c057cfd7fab08efbd7f1f8ec992df90d7e2a34468d74c6b7e5
+  metadata.gz: de3f92649c3322d05cbcd21218815e59c804cc850fdbf17536b19bcaf92bf7b0630f1ff0c536fa59dfbc45d668eb3b1facd568ce9ddc4678c5a5a7ea79eff4f9
+  data.tar.gz: 3f13439f0b3f06ee18aba8438fc953d1cb7695af872c339fcc8221c0341aaeb32bd3b13f7a0762362106c1916e611854e25bef45f7d5cce0ec38841b7e91d5ca

data/.hound.yml

@@ -0,0 +1,34 @@
+AllCops:
+  Exclude:
+    - vendor/**/**
+    - bin/**
+    - gratitude.gemspec
+
+CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    map: 'collect'
+    map!: 'collect!'
+    reduce: 'inject'
+    find: 'detect'
+    find_all: 'select'
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.rubocop.yml

@@ -0,0 +1,34 @@
+AllCops:
+  Exclude:
+    - vendor/**/**
+    - bin/**
+    - gratitude.gemspec
+
+CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    map: 'collect'
+    map!: 'collect!'
+    reduce: 'inject'
+    find: 'detect'
+    find_all: 'select'
+
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+SignalException:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -7,4 +7,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - jruby-19mode
-  - rbx
+  - rbx-2
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -1,5 +1,5 @@
-### 0.1.0 (Upcoming Stable Release)
-* Implement all aspects of the Gittip API.
+### 0.1.0 (May 16, 2014)
+* Add custom errors for authentication issues, incorrect usernames and tip update errors.
 
 ### 0.0.12 (March 30, 2014)
 * Add support for Chart API endpoint

data/CONTRIBUTING.md

@@ -0,0 +1,97 @@
+Contributing to Gratitude
+=====================
+
+If you'd like to contribute to Gratitude, you're encouraged to submit [pull requests](https://github.com/JohnKellyFerguson/gratitude/pulls), [propose features and discuss issues](https://github.com/JohnKellyFerguson/gratitude/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/JohnKellyFerguson/gratitude) and check out your copy.
+
+```
+git clone https://github.com/contributor/gratitude.git
+cd gratitude
+git remote add upstream https://github.com/JohnKellyFerguson/gratitude.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [spec/gratitude](spec/gratitude).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to [Gratitude's Github Project Page](https://github.com/contributor/gratitude) and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and check to see whether everything passed on Travis-CI. Everything should look green, otherwise fix any remaining issues.
+
+
+#### Thank You
+
+Your contributions are greatly appreciated. Thanks for helping out!

data/Gemfile

@@ -3,16 +3,21 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem 'jazz_hands', github: 'nixme/jazz_hands', branch: 'bring-your-own-debugger'
-  gem 'pry-byebug'
-  gem 'pry-coolline'
-  gem "guard-rspec"
+  gem "jazz_hands", github: "nixme/jazz_hands", branch: "bring-your-own-debugger"
+  gem "pry-byebug"
+  gem "pry-coolline"
+  gem "guard-rubocop", require: false
+  gem "guard-rspec", require: false
   gem "terminal-notifier-guard", require: false
 end
 
+group :development, :test do
+  gem "rubocop"
+end
+
 group :test do
-  gem "rspec", '~> 3.0.0.beta2'
+  gem "rspec", "~> 3.0.0.beta2"
   gem "webmock"
   gem "vcr"
-  gem 'coveralls', require: false
+  gem "coveralls", require: false
 end

data/Guardfile

@@ -4,3 +4,7 @@ guard :rspec do
   watch('spec/spec_helper.rb')  { "spec" }
 end
 
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -371,6 +371,9 @@ client.current_tips
 ```
 
 
+### Contributing
+
+If you'd like to contribute to Gratitude, please check out our [CONTRIBUTING guidelines](CONTRIBUTING.md).
 
 ### Copyright and License
 

data/Rakefile

@@ -1,28 +1,30 @@
-require 'rubygems'
-require 'bundler/gem_tasks'
+# encoding: utf-8
+
+require "rubygems"
+require "bundler/gem_tasks"
 
 Bundler.setup :default, :development
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
-task :default => :spec
+task default: :spec
 
 task :console do
-  require 'irb'
-  require 'irb/completion'
-  require 'gratitude'
+  require "irb"
+  require "irb/completion"
+  require "gratitude"
   ARGV.clear
   IRB.start
 end
 
 task :pry do
-  require 'pry'
-  require 'gratitude'
+  require "pry"
+  require "gratitude"
   ARGV.clear
   Pry.start
 end

data/gratitude.gemspec

@@ -1,15 +1,15 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gratitude/version'
+require "gratitude/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "gratitude"
   spec.version       = Gratitude::VERSION
   spec.authors       = ["John Kelly Ferguson"]
   spec.email         = ["hello@johnkellyferguson.com"]
-  spec.description   = %q{A simple Ruby wrapper for the Gittip API.}
-  spec.summary       = %q{A simple Ruby wrapper for the Gittip API.}
+  spec.description   = %q(A simple Ruby wrapper for the Gittip API.)
+  spec.summary       = %q(A simple Ruby wrapper for the Gittip API.)
   spec.homepage      = "https://github.com/JohnKellyFerguson/gratitude"
   spec.license       = "MIT"
 

data/lib/gratitude/chart.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Gratitude
   class Chart
     extend Connection
@@ -34,14 +36,12 @@ module Gratitude
       all.sort_by { |chart| chart.date }.reverse
     end
 
-    private
-
-    def self.get_charts_from_gittip
-      faraday.get('/about/charts.json').body.to_a
+    def self.charts_from_gittip
+      faraday.get("/about/charts.json").body.to_a
     end
 
     def self.collect_charts
-      get_charts_from_gittip.each do |chart_hash|
+      charts_from_gittip.each do |chart_hash|
         Chart.new(chart_hash)
       end
     end

data/lib/gratitude/client.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "gratitude/connection"
 require "gratitude/tips"
 
@@ -13,6 +15,5 @@ module Gratitude
       @api_key = options[:api_key]
       faraday.basic_auth(api_key, "")
     end
-
   end # Payday
 end # Gratitude

data/lib/gratitude/connection.rb

@@ -1,8 +1,10 @@
+# encoding: utf-8
+
 module Gratitude
   module Connection
     def faraday
-      @faraday ||= Faraday.new(:url => "https://www.gittip.com/") do |faraday|
-        faraday.response :json, :content_type => /\bjson$/
+      @faraday ||= Faraday.new(url: "https://www.gittip.com/") do |faraday|
+        faraday.response :json, content_type: /\bjson$/
         faraday.adapter Faraday.default_adapter
       end
     end

data/lib/gratitude/error.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+module Gratitude
+  class UsernameNotFoundError < StandardError
+    def initialize(username)
+      super(
+        "The requested username, '#{username}', could not be found."\
+        "Please note that Gittip API requests are case sensitive.")
+    end
+  end
+
+  class AuthenticationError < StandardError
+    def initialize
+      super(
+        "The supplied username and api_key could not properly authenticate "\
+        "with Gittip.")
+    end
+  end
+
+  class TipUpdateError < StandardError
+    def initialize(usernames)
+      combined_usernames = usernames.join(", ")
+      super(
+      "There was an error updating the tip(s) for the following user(s): "\
+      "#{combined_usernames}.")
+    end
+  end
+end

data/lib/gratitude/payday.rb

@@ -1,12 +1,15 @@
+# encoding: utf-8
+
 module Gratitude
   class Payday
     extend Connection
     PAYDAYS = []
 
     attr_reader :ach_fees_volume, :ach_volume, :charge_fees_volume,
-                :charge_volume, :number_of_ach_credits, :number_of_active_users,
-                :number_of_failing_credit_cards, :number_of_missing_credit_cards,
-                :number_of_charges, :number_of_participants, :number_of_tippers,
+                :charge_volume, :number_of_ach_credits,
+                :number_of_active_users, :number_of_failing_credit_cards,
+                :number_of_missing_credit_cards, :number_of_charges,
+                :number_of_participants, :number_of_tippers,
                 :number_of_transfers, :transfer_volume, :transfer_end_time,
                 :transfer_start_time
 
@@ -39,7 +42,9 @@ module Gratitude
       @number_of_tippers = options["ntippers"]
       @number_of_transfers = options["ntransfers"]
       @transfer_volume = options["transfer_volume"]
-      @transfer_end_time = DateTime.parse(options["ts_end"]) if options["ts_end"]
+      if options["ts_end"]
+        @transfer_end_time = DateTime.parse(options["ts_end"])
+      end
       if options["ts_start"]
         @transfer_start_time = DateTime.parse(options["ts_start"])
       end
@@ -64,17 +69,14 @@ module Gratitude
       all.sort_by { |p| p.ts_end }.reverse
     end
 
-    private
-
-    def self.get_paydays_from_gittip
-      faraday.get('/about/paydays.json').body.to_a
+    def self.paydays_from_gittip
+      faraday.get("/about/paydays.json").body.to_a
     end
 
     def self.collect_paydays
-      get_paydays_from_gittip.each do |payday_hash|
+      paydays_from_gittip.each do |payday_hash|
         Payday.new(payday_hash)
       end
     end
-
   end # Payday
 end # Gratitude

data/lib/gratitude/profile.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module Gratitude
   class Profile
     include Connection
@@ -100,11 +102,12 @@ module Gratitude
 
     def response
       @response ||= faraday.get("/#{username}/public.json")
+      raise UsernameNotFoundError, username if @response.status == 406
+      @response
     end
 
     def response_body
       @response_body ||= response.body
     end
-
   end # Profile
 end # Gratitude

data/lib/gratitude/statistics.rb

@@ -1,25 +1,27 @@
+# encoding: utf-8
+
 module Gratitude
   class Statistics
     include Connection
 
     class << self
-      alias :current :new
+      alias_method :current, :new
     end
 
     def average_tip_amount
       response_body["average_tip"]
     end
-    alias :average_tip :average_tip_amount
+    alias_method :average_tip, :average_tip_amount
 
     def average_number_of_tippees
       response_body["average_tippees"]
     end
-    alias :average_tippees :average_number_of_tippees
+    alias_method :average_tippees, :average_number_of_tippees
 
     def amount_in_escrow
       response_body["escrow"]
     end
-    alias :escrow :amount_in_escrow
+    alias_method :escrow, :amount_in_escrow
 
     def last_thursday
       response_body["last_thursday"]
@@ -28,33 +30,33 @@ module Gratitude
     def number_of_ach_credits
       response_body["nach"].to_i
     end
-    alias :nach :number_of_ach_credits
-    alias :number_of_achs :number_of_ach_credits
+    alias_method :nach, :number_of_ach_credits
+    alias_method :number_of_achs, :number_of_ach_credits
 
     def number_of_active_users
       response_body["nactive"]
     end
-    alias :nactive :number_of_active_users
+    alias_method :nactive, :number_of_active_users
 
     def number_of_credit_cards
       response_body["ncc"]
     end
-    alias :ncc :number_of_credit_cards
+    alias_method :ncc, :number_of_credit_cards
 
     def number_of_givers
       response_body["ngivers"]
     end
-    alias :ngivers :number_of_givers
+    alias_method :ngivers, :number_of_givers
 
     def number_who_give_and_receive
       response_body["noverlap"]
     end
-    alias :noverlap :number_who_give_and_receive
+    alias_method :noverlap, :number_who_give_and_receive
 
     def number_of_receivers
       response_body["nreceivers"]
     end
-    alias :nreceivers :number_of_receivers
+    alias_method :nreceivers, :number_of_receivers
 
     def other_people
       response_body["other_people"]
@@ -63,12 +65,12 @@ module Gratitude
     def percentage_of_users_with_credit_cards
       response_body["pcc"].strip
     end
-    alias :pcc :percentage_of_users_with_credit_cards
+    alias_method :pcc, :percentage_of_users_with_credit_cards
 
     def punctuation
       response_body["punc"]
     end
-    alias :punc :punctuation
+    alias_method :punc, :punctuation
 
     def statements
       response_body["statements"]
@@ -85,12 +87,12 @@ module Gratitude
     def number_of_tips
       response_body["tip_n"]
     end
-    alias :tip_n :number_of_tips
+    alias_method :tip_n, :number_of_tips
 
     def value_of_total_backed_tips
       response_body["total_backed_tips"]
     end
-    alias :total_backed_tips :value_of_total_backed_tips
+    alias_method :total_backed_tips, :value_of_total_backed_tips
 
     def transfer_volume
       response_body["transfer_volume"]
@@ -99,7 +101,7 @@ module Gratitude
     private
 
     def response
-      @response ||= faraday.get('/about/stats.json')
+      @response ||= faraday.get("/about/stats.json")
     end
 
     def response_body

data/lib/gratitude/tips.rb

@@ -1,9 +1,15 @@
+# encoding: utf-8
+
 module Gratitude
   class Client
     module Tips
-
       def current_tips
-        faraday.get(tips_url).body
+        begin
+          response = faraday.get(tips_url)
+        rescue Faraday::Error::ParsingError
+          raise AuthenticationError
+        end
+        response.body
       end
 
       def current_tips_total
@@ -11,24 +17,35 @@ module Gratitude
       end
 
       def update_tips(array_of_hashes_with_usernames_and_amounts)
-        faraday.post do |request|
-          payload_for(request, array_of_hashes_with_usernames_and_amounts)
-        end.body
+        post_tips_to_gittip(array_of_hashes_with_usernames_and_amounts)
       end
 
       def update_tips_and_prune(array_of_hashes_with_usernames_and_amounts)
-        faraday.post do |request|
-          payload_for(request, array_of_hashes_with_usernames_and_amounts)
-          request.params = { :also_prune => "true"}
-        end.body
+        post_tips_to_gittip(
+          array_of_hashes_with_usernames_and_amounts, prune: true
+        )
       end
 
-    private
+      private
 
       def tips_url
         "/#{username}/tips.json"
       end
 
+      def post_tips_to_gittip(array_of_hashes, options = {})
+        response = faraday_post_response(array_of_hashes, options)
+        return_response_body_or_raise_update_error(response)
+      end
+
+      def faraday_post_response(array_of_hashes, options = {})
+        faraday.post do |request|
+          payload_for(request, array_of_hashes)
+          request.params = { also_prune: "true" } if options[:prune] == true
+        end
+      rescue
+        raise AuthenticationError
+      end
+
       def payload_for(request, array_of_hashes)
         request.url(tips_url)
         request.body = prepared_tips_array(array_of_hashes).to_json
@@ -50,6 +67,21 @@ module Gratitude
         }
       end
 
+      def return_response_body_or_raise_update_error(response)
+        if usernames_with_errors(response.body).size > 0
+          raise TipUpdateError, usernames_with_errors(response.body)
+        else
+          response.body
+        end
+      end
+
+      def usernames_with_errors(response_body)
+        response_body.each_with_object([]) do |user_tip_response, array|
+          if user_tip_response.key?("error")
+            array << user_tip_response["username"]
+          end
+        end
+      end
     end # Tips
   end # Client
 end # Gratitude