gratitude 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3426a86627d58024de176a96959857d0032a69d
-  data.tar.gz: c918f9fc3804023c7985c283c967d37dd83eae8e
+  metadata.gz: 7549b619bcc85a81bc995ca6a09f0363b52548e0
+  data.tar.gz: 704297b6b8f5f6b69dfed8b40b3ac73a7b8a179d
 SHA512:
-  metadata.gz: beacd24fcdf3e11cc1459d76a9dc4bdaf3361368c2bc235a0c4d7faa42b2285d5d4e90cc7f45372b6ac40282dcc73cc2390006a24ebe3039f5408900fcbe95dc
-  data.tar.gz: 87acf159f83bde5b85702f7a89e2bfac096fbc7db258aefb49c6e99ce29fecc24ff1d1be4752473fe0fea0bc37cbaf11f237ec61f40540a82fc68fe36ad471c1
+  metadata.gz: 9cb95f6be06a1f320b7066e338eb84ac6f2a59fe984100fdaf6a6833bf08931c041bc46678164aa70266ee938e6e1f5f9bd5fa6c4153de3ea812763705af5c5a
+  data.tar.gz: 8d51cb9fcbf942090fc7299b8de17338e850035853da7ee6c6738c20fd699a1e81442a45eaf13e4eed150064f75cf08e4ca7ab07e46cbdac8d83952a5d1d9808

data/.rspec

@@ -1,2 +1,2 @@
 --format documentation
---color
+--color

data/CHANGELOG.md

@@ -1,37 +1,41 @@
 ### 0.1.0 (Upcoming Stable Release)
 * Implement all aspects of the Gittip API.
 
-### 0.0.10
+### 0.0.11 (March 29, 2014)
+* Change to Faraday instead of HTTParty
+* Update api methods to match current Gittip api implementation
+
+### 0.0.10 (March 27, 2014)
 * Add rake console task to enter an IRB session with Gratitude required
 * Simplify Tip's public interface
 
-### 0.0.9 (10/19/2013)
+### 0.0.9 (October 19, 2013)
 * Add ability to update a user's current tips.
 
-### 0.0.8 (10/18/2013)
+### 0.0.8 (October 18, 2013)
 * Add client authentication.
 * Add ability to retrieve a user's current tips.
 
-### 0.0.7 (10/13/2013)
+### 0.0.7 (October 13, 2013)
 * Update documentation.
 * Alias new to current in Statistics class.
 
-### 0.0.6 (9/19/2013)
+### 0.0.6 (October 19, 2013)
 * Complete Gittip's Statistics API integration.
 * Add more aliases and improve method clarity to signify method intent.
 
-### 0.0.5 (9/17/2013)
+### 0.0.5 (September 17, 2013)
 * Complete Gittip's Paydays API integration.
 * Add aliases for all methods to correspond to Gittip's original API documentation.
 
-### 0.0.4 (9/14/2013)
+### 0.0.4 (September 14, 2013)
 * Improve integration with Gittip's Public User API to better account for different user settings.
 
-### 0.0.3 (9/11/2013)
+### 0.0.3 (September 11, 2013)
 * Fix release version.
 
-### 0.0.2 (9/11/2013)
+### 0.0.2 (September 11, 2013)
 * Add ability to get a Gittip user's public information.
 
-### 0.0.1 (9/10/2013)
+### 0.0.1 (September 10, 2013)
 * Initial release.

data/Gemfile

@@ -2,14 +2,16 @@ source "https://rubygems.org"
 
 gemspec
 
-group :development, :test do
-  gem "rspec", '~> 3.0.0.beta2'
-  gem "webmock"
-  gem "vcr"
+group :development do
   gem "pry"
   gem "awesome_print"
+  gem "guard-rspec"
+  gem "terminal-notifier-guard", require: false
 end
 
 group :test do
+  gem "rspec", '~> 3.0.0.beta2'
+  gem "webmock"
+  gem "vcr"
   gem 'coveralls', require: false
-end
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -21,9 +21,9 @@ A simple Ruby wrapper for the [Gittip API](https://github.com/gittip/www.gittip.
 The gratitude gem has four different components that interact with different aspects of the Gittip API. They are as follows:
 
 * [Paydays](#paydays-source-code)
-* [Statistics](#statistics)
+* [Statistics](#statistics-source-code)
 * [Profile](#profile-source-code)
-* [Tips](#tips)
+* [Tips](#tips-client-authentication-source-code-tips-source-code)
 
 When using gratitude to retrieve data from the Gittip API, please note that many of the JSON key names have been wrapped in more naturally sounding method names. However, all of the original JSON key names have also been maintained as aliases so as to maitain consistency with the original [Gittip API documentation](https://github.com/gittip/www.gittip.com#api).
 
@@ -63,6 +63,11 @@ paydays.each do |payday|
 end
 ```
 
+If you want to get the oldest payday:
+```ruby
+Gratitude::Payday.oldest_payday
+```
+
 Finally, if you just want to get the most recent payday, you can do so by using:
 
 ```ruby
@@ -125,32 +130,53 @@ Gratitude::Profile.new("johnkellyferguson")
 The above will retrieve the public profile of the above user. You can then access all of the different information with the following methods:
 
 * `avatar_url` (alias: `avatar`)
-* `bitbucket_api_url` (alias: `bitbucket`)
-  * returns the user's bitbucket api url if they have connected a bitbucket account.
+* `bitcoin`
+	* returns a link to the user's bitcoin address
+* `bitbucket`
+  * returns a hash containing their bitbucket username, id, and user id if the user has connected their bitbucket account.
   * otherwise, returns `nil`.
 * `bitbucket_username`
   * returns the user's bitbucket username if they have connected a bitbucket account.
   * otherwise, returns `nil`.
-* `bountysource_api_url` (alias: `bountysource`)
-  * returns the user's bountysource api url if they have connected a bountysource account.
+* `bountysource`
+  * returns a hash containing their bountysource username, id, and user id if the user has connected their bountysource account.
   * otherwise, returns `nil`.
 * `bountysource_username`
   * returns the user's bountysource username if they have connected a bountysource account.
   * otherwise, returns `nil`.
-* `github_api_url` (alias: `github`)
-  * returns the user's github api url if they have connected a github account.
+* `github`
+  * returns a hash containing their github username, id, and user id if the user has connected their github account.
   * otherwise, returns `nil`.
 * `github_username`
   * returns the user's github username if they have connected a github account.
   * otherwise, returns `nil`.
-* `twitter_api_url` (alias: `twitter`)
-  * returns the user's twitter api url if they have connected a twitter account.
+* `openstreetmap`
+  * returns a hash containing their openstreetmap username, id, and user id if the user has connected their openstreetmap account.
+  * otherwise, returns `nil`.
+* `openstreetmap_username`
+  * returns the user's openstreetmap username if they have connected a openstreetmap account.
+  * otherwise, returns `nil`.
+* `twitter`
+  * returns a hash containing their twitter username, id, and user id if the user has connected their twitter account.
+  * otherwise, returns `nil`.
+* `twitter_username`
+  * returns the user's twitter username if they have connected a twitter account.
+  * otherwise, returns `nil`.
+* `venmo`
+  * returns a hash containing their venmo username, id, and user id if the user has connected their venmo account.
   * otherwise, returns `nil`.
+* `venmo_username`
+  * returns the user's venmo username if they have connected a venmo account.
+  * otherwise, returns `nil`. 
 * `amount_giving` (alias: `giving`)
   * returns the amount (as a float) the user has pledged to give this week.
   * if the user has decided to donately privately then this will return 0.00.
 * `amount_receiving` (alias: `receiving`)
   * returns an estimate as a float of what the given user is expected to receive this week.
+* `number_of_patrons` (alias: `npatrons`)
+	*  returns the number of other gittipers that donate to the user being queried.
+* `on`
+	* returns the platform name: "gittip"
 * `goal`
   * returns the amount (as a float) that the user would like to receive weekly if the user set such a goal.
   * returns `nil` if the user has defined themselves as a patron or has not set a specific monetary goal.
@@ -159,7 +185,6 @@ The above will retrieve the public profile of the above user. You can then acces
 * `id`
   * the id of the user.
 
-**TODO:** Implement the `my_tip` method into the Profile section once client authentication is finished.
 
 ##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 and update the current tips of an authenticated user. In order to interact with this aspect of the API, 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.

data/gratitude.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty", "~> 0.11"
+  spec.add_dependency "faraday", "~> 0.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9"
   spec.add_dependency "json"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
 end

data/lib/gratitude.rb

@@ -1,6 +1,8 @@
-require "httparty"
+require "faraday"
+require "faraday_middleware"
 
 require "gratitude/client"
+require "gratitude/connection"
 require "gratitude/payday"
 require "gratitude/profile"
 require "gratitude/statistics"

data/lib/gratitude/client.rb

@@ -1,8 +1,9 @@
+require "gratitude/connection"
 require "gratitude/tips"
 
 module Gratitude
   class Client
-    include HTTParty
+    include Gratitude::Connection
     include Gratitude::Client::Tips
 
     attr_reader :username, :api_key
@@ -10,7 +11,8 @@ module Gratitude
     def initialize(options = {})
       @username = options[:username]
       @api_key = options[:api_key]
+      faraday.basic_auth(api_key, "")
     end
 
   end # Payday
-end # Gratitude
+end # Gratitude

data/lib/gratitude/connection.rb

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

data/lib/gratitude/payday.rb

@@ -1,7 +1,6 @@
 module Gratitude
   class Payday
-    include HTTParty
-    base_uri "https://www.gittip.com/about/paydays.json"
+    extend Connection
     PAYDAYS = []
 
     attr_reader :ach_fees_volume, :ach_volume, :charge_fees_volume,
@@ -11,19 +10,20 @@ module Gratitude
                 :number_of_transfers, :transfer_volume, :transfer_end_time,
                 :transfer_start_time
 
-    # Provide aliases so all methods can correspond to the original Gittip API names.
-    alias :nachs :number_of_ach_credits
-    alias :number_of_achs :number_of_ach_credits
-    alias :nactive :number_of_active_users
-    alias :number_active :number_of_active_users
-    alias :ncc_failing :number_of_failing_credit_cards
-    alias :ncc_missing :number_of_missing_credit_cards
-    alias :ncharges :number_of_charges
-    alias :nparticipants :number_of_participants
-    alias :ntippers :number_of_tippers
-    alias :ntransfers :number_of_transfers
-    alias :ts_end :transfer_end_time
-    alias :ts_start :transfer_start_time
+    # Provide aliases so all methods can correspond to the original
+    # Gittip API names.
+    alias_method :nachs, :number_of_ach_credits
+    alias_method :number_of_achs, :number_of_ach_credits
+    alias_method :nactive, :number_of_active_users
+    alias_method :number_active, :number_of_active_users
+    alias_method :ncc_failing, :number_of_failing_credit_cards
+    alias_method :ncc_missing, :number_of_missing_credit_cards
+    alias_method :ncharges, :number_of_charges
+    alias_method :nparticipants, :number_of_participants
+    alias_method :ntippers, :number_of_tippers
+    alias_method :ntransfers, :number_of_transfers
+    alias_method :ts_end, :transfer_end_time
+    alias_method :ts_start, :transfer_start_time
 
     def initialize(options = {})
       @ach_fees_volume = options["ach_fees_volume"]
@@ -54,12 +54,18 @@ module Gratitude
       sort_by_ts_end.first
     end
 
+    def self.oldest_payday
+      sort_by_ts_end.last
+    end
+
     def self.sort_by_ts_end
       all.sort_by { |p| p.ts_end }.reverse
     end
 
+    private
+
     def self.get_paydays_from_gittip
-      get(base_uri).to_a
+      faraday.get('/about/paydays.json').body.to_a
     end
 
     def self.collect_paydays
@@ -69,4 +75,4 @@ module Gratitude
     end
 
   end # Payday
-end # Gratitude
+end # Gratitude

data/lib/gratitude/profile.rb

@@ -1,78 +1,109 @@
 module Gratitude
   class Profile
-    include HTTParty
-    base_uri "https://www.gittip.com"
-    URI_SUFFIX = "/public.json"
-
-    attr_reader :username, :response
+    include Connection
+    attr_reader :username
 
     def initialize(username)
       @username = username
-      @response = self.class.get("/#{username}#{URI_SUFFIX}")
     end
 
     def avatar_url
-      response["avatar"]
+      response_body["avatar"]
+    end
+    alias_method :avatar, :avatar_url
+
+    def bitcoin
+      response_body["bitcoin"]
     end
-    alias :avatar :avatar_url
 
-    def bitbucket_api_url
-      response["elsewhere"]["bitbucket"]
+    def bitbucket
+      response_body["elsewhere"]["bitbucket"]
     end
-    alias :bitbucket :bitbucket_api_url
 
     def bitbucket_username
-      bitbucket_api_url.gsub("https://bitbucket.org/api/1.0/users/", "") if bitbucket_api_url
+      bitbucket["user_name"] if bitbucket
     end
 
-    def bountysource_api_url
-      response["elsewhere"]["bountysource"]
+    def bountysource
+      response_body["elsewhere"]["bountysource"]
     end
-    alias :bountysource :bountysource_api_url
 
     def bountysource_username
-      bountysource_api_url.gsub("https://api.bountysource.com/users/", "") if bountysource_api_url
+      bountysource["user_name"] if bountysource
     end
 
-    def github_api_url
-      response["elsewhere"]["github"]
+    def github
+      response_body["elsewhere"]["bountysource"]
     end
-    alias :github :github_api_url
 
     def github_username
-      github_api_url.gsub("https://api.github.com/users/", "") if github_api_url
+      github["user_name"] if github
+    end
+
+    def openstreetmap
+      response_body["elsewhere"]["openstreetmap"]
     end
 
-    def twitter_api_url
-      response["elsewhere"]["twitter"]
+    def openstreetmap_username
+      openstreetmap["user_name"] if openstreetmap
+    end
+
+    def twitter
+      response_body["elsewhere"]["twitter"]
     end
-    alias :twitter :twitter_api_url
 
     def twitter_username
-      nil
+      twitter["user_name"] if twitter
+    end
+
+    def venmo
+      response_body["elsewhere"]["venmo"]
+    end
+
+    def venmo_username
+      venmo["user_name"] if venmo
     end
 
     def amount_giving
-      response["giving"].to_f
+      response_body["giving"].to_f
     end
-    alias :giving :amount_giving
+    alias_method :giving, :amount_giving
 
     def amount_receiving
-      response["receiving"].to_f
+      response_body["receiving"].to_f
     end
-    alias :receiving :amount_receiving
+    alias_method :receiving, :amount_receiving
 
     def goal
-      response["goal"].to_f if response["goal"]
+      response_body["goal"].to_f if response_body["goal"]
     end
 
     def account_type
-      response["number"]
+      response_body["number"]
     end
-    alias :number :account_type
+    alias_method :number, :account_type
 
     def id
-      response["id"]
+      response_body["id"]
+    end
+
+    def number_of_patrons
+      response_body["npatrons"]
+    end
+    alias_method :npatrons, :number_of_patrons
+
+    def on
+      response_body["on"]
+    end
+
+    private
+
+    def response
+      @response ||= faraday.get("/#{username}/public.json")
+    end
+
+    def response_body
+      @response_body ||= response.body
     end
 
   end # Profile