yoyo 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffca99b3259c955b70b3d4e3612f3ca0d86350d6
-  data.tar.gz: b59d30b8bef71f37888449ab7d2cdb7b0e85d798
+  metadata.gz: 90b02ddb5550e8460e1be202000e09ed174571d4
+  data.tar.gz: 5c43937772435ee12293d705a534c851cdc58eca
 SHA512:
-  metadata.gz: ffe2558b41f29847c30a53f92796fc0527ab71cfdefef132cdc2c260c371aab8ac8361c87319bcff0490fb121838a343cd4d560e657e94376bdc0a168a537494
-  data.tar.gz: e3be52000804fd804525f4902ea7320e43199e31c0b2af2b9e5723e5a6077a237893b28f8f57f12641cea2c12ae0a7694a57f52bc4d9da07ffbd97a036c8958d
+  metadata.gz: 28af955e3d3a8bd8503d7be9555ee0416891ec92bdb8ae6d43d093c29e7c44846a65df57fcd377f6a0bf0e6c0ee94b882e56975622ffefb5aca8792c6f69bfab
+  data.tar.gz: bd40041526be08d7a3afbc96f01ae55c05bfe9e6e9aeca2f2f10dc3698afe339f4bae621678bb2289ce410fe70a3c1c208e4a65ee05048d4fc4346361aa2c1aa

data/README.md

@@ -28,7 +28,11 @@ yo.yo("SOME_YO_USER")
 
 # mass YO everyone who has ever YO'd your API account
 yo.yo_all
+
+# find out how many subscribers you have. OMG
+yo.subscribers_count
 ```
+
 That's ... that's pretty much their entire API
 
 ## Why would I install this gem instead of just using `curl`?

data/lib/yoyo.rb

@@ -1,5 +1,7 @@
 require "yoyo/version"
 require 'faraday'
+require 'json'
+require 'ostruct'
 
 module Yoyo
   class Yo
@@ -15,6 +17,14 @@ module Yoyo
     # I mean API.
     attr_reader :api_connection
 
+    # Struct containing all relevant data from the Yo request
+    #
+    # result#response => Faraday::Response
+    # result#parsed => JSON parsed response body
+    # result#error => populated if request error'd :(
+    # result#result => horribly named store for success response
+    attr_reader :result
+
     # You're going to need an API token to get started.
     # You can get one from http://dev.justyo.co/
     def initialize(api_token)
@@ -29,13 +39,13 @@ module Yoyo
     # Usage: yo("PHILCRISSMAN") 
     # Returns a Faraday response, so you can see the HTTP status and errors, if any
     def yo(some_user)
-      api_connection.post "/yo/", { api_token: api_token, username: some_user }
+      build_result :post, "/yo/", username: some_user
     end
 
     # Say YO to everyone who has ever YO'd your API account
     # Should return an empty body. YOs all your subscribers
     def yo_all
-      api_connection.post "/yoall/", { api_token: api_token }
+      build_result :post, "/yoall/"
     end
 
     # Get the number of subscribers you have. That sounds handy.
@@ -51,7 +61,33 @@ module Yoyo
     #
     # That's not too hard.
     def subscribers_count
-      api_connection.get "/subscribers_count/", { api_token: api_token }
+      build_result :get, "/subscribers_count/"
+      result.result
+    end
+
+    private
+
+    def build_result(method, path, opts={})
+      tap do
+        response = api_connection.send(method, path, opts.merge(api_token: api_token))
+        begin
+          parsed = JSON::parse(response.body)
+        rescue JSON::ParserError => e
+          # if we can't parse the JSON, Yo may have just returned 
+          # a string (not JSON). It (currently) does this when
+          # rate limiting (eg, try to YO the same user twice 
+          # within a minute)
+          parsed = {"error" => response.body.gsub("\"", '')}
+        end
+
+        @result = OpenStruct.new({
+          response: response,
+          parsed: parsed,
+          error: parsed['error'],
+          result: parsed['result']
+        })
+      end
     end
   end
 end
+

data/lib/yoyo/version.rb

@@ -1,5 +1,5 @@
 module Yoyo
   # This is what version of Yoyo this is!
   # They grow up so fast.
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/yoyo_test.rb

@@ -23,28 +23,48 @@ class YoyoTest < Minitest::Test
 
   def test_yo_initialization_with_no_token
     assert_raises ArgumentError do
-      yo = Yoyo::Yo.new
+      Yoyo::Yo.new
     end
   end
 
   def test_saying_yo
     yo = Yoyo::Yo.new("some-token")
 
-    response = yo.yo("PHILCRISSMAN")
-    assert_equal "{\"result\": \"OK\"}", response.body
+    yo.yo("PHILCRISSMAN")
+    assert_equal "{\"result\": \"OK\"}", yo.result.response.body
+    assert_equal({'result' => "OK"}, yo.result.parsed)
+    assert_equal "OK", yo.result.result
+    assert_equal nil, yo.result.error
+  end
+
+  def test_rate_limited
+    @rate_limited_test_connection = Faraday.new do |builder|
+      builder.adapter :test do |stub|
+        stub.post('/yo/') { [400, {}, "\"Rate limit exceeded. Only one Yo per recipient per minute.\""] }
+      end
+    end
+
+    Yoyo::Yo.any_instance.stubs(:api_connection).returns(@rate_limited_test_connection)
+
+    yo = Yoyo::Yo.new("some-token")
+
+    yo.yo("PHILCRISSMAN")
+    assert_equal "\"Rate limit exceeded. Only one Yo per recipient per minute.\"", yo.result.response.body
+    assert_equal "Rate limit exceeded. Only one Yo per recipient per minute.", yo.result.error
+
+    Yoyo::Yo.any_instance.unstub(:api_connection)
   end
 
   def test_saying_yo_all
     yo = Yoyo::Yo.new("some-token")
 
-    response = yo.yo_all
-    assert_equal "{}", response.body
+    yo.yo_all
+    assert_equal "{}", yo.result.response.body
   end
 
   def test_get_subscriber_count
     yo = Yoyo::Yo.new("some-token")
 
-    response = yo.subscribers_count
-    assert_equal "{\"result\": 9001}", response.body
+    assert_equal 9001, yo.subscribers_count
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: yoyo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Phil Crissman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   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'
 description: It's a ruby gem for using the YO API. You need to get an API Token, okay?
@@ -87,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -106,12 +106,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []