yoyo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ac8042a99ac1674762b1115dfe614d43833b611
-  data.tar.gz: e025b47d42de78c6e892c8db22a9418a5f8e2c16
+  metadata.gz: ffca99b3259c955b70b3d4e3612f3ca0d86350d6
+  data.tar.gz: b59d30b8bef71f37888449ab7d2cdb7b0e85d798
 SHA512:
-  metadata.gz: c6e54c7a25019f9eadd6ab5fc340707a96c62d0b59b0cf9e889de578032f8dc6a10934d1e10cb50c9cc4133c12fe6132a6a40aca775a41ff9c14a028ee107ae3
-  data.tar.gz: 5438d1d681fd211ee870ba8069538623129b9e4edc00f1484603ddc369626d5de0970ee4468da48311c0dbfdc52916f6d77d93054530a0f2573796cbdd27efa2
+  metadata.gz: ffe2558b41f29847c30a53f92796fc0527ab71cfdefef132cdc2c260c371aab8ac8361c87319bcff0490fb121838a343cd4d560e657e94376bdc0a168a537494
+  data.tar.gz: e3be52000804fd804525f4902ea7320e43199e31c0b2af2b9e5723e5a6077a237893b28f8f57f12641cea2c12ae0a7694a57f52bc4d9da07ffbd97a036c8958d

data/lib/yoyo.rb

@@ -3,9 +3,20 @@ require 'faraday'
 
 module Yoyo
   class Yo
+    # = Yoyo
+    #
+    # Yoyo is a gem for accessing the YO api. I hope you like it!
+
+    # This is your API token.
+    # There are many like it, but this one is yours. See http://dev.justyo.co/
     attr_reader :api_token
+
+    # This is just a reference to the HTTP connection to the YO mothership.
+    # I mean API.
     attr_reader :api_connection
 
+    # You're going to need an API token to get started.
+    # You can get one from http://dev.justyo.co/
     def initialize(api_token)
       @api_token = api_token
       @api_connection = Faraday.new(:url => "http://api.justyo.co/") do |f|
@@ -15,13 +26,32 @@ module Yoyo
     end
 
     # Say YO to someone from your API account
+    # 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 }
     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 }
     end
+
+    # Get the number of subscribers you have. That sounds handy.
+    # Does YO document this anywhere? I can't find it.
+    # Returns a Faraday response.
+    # To get the count, you could:
+    # 
+    #   require 'JSON'
+    #   yo = Yoyo::Yo.new('your-token')
+    #   count = yo.subscribers_count
+    #   response_hash = JSON.parse(count.body)
+    #   response_hash['result']
+    #
+    # That's not too hard.
+    def subscribers_count
+      api_connection.get "/subscribers_count/", { api_token: api_token }
+    end
   end
 end

data/lib/yoyo/version.rb

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

data/test/yoyo_test.rb

@@ -9,6 +9,7 @@ class YoyoTest < Minitest::Test
       builder.adapter :test do |stub|
         stub.post('/yo/') { [200, {}, "{\"result\": \"OK\"}"] }
         stub.post('/yoall/') { [201, {}, "{}"] }
+        stub.get('/subscribers_count/') { [200, {}, "{\"result\": 9001}"] }
       end
     end
 
@@ -39,4 +40,11 @@ class YoyoTest < Minitest::Test
     response = yo.yo_all
     assert_equal "{}", response.body
   end
+
+  def test_get_subscriber_count
+    yo = Yoyo::Yo.new("some-token")
+
+    response = yo.subscribers_count
+    assert_equal "{\"result\": 9001}", response.body
+  end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: yoyo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Phil Crissman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-29 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,17 +106,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: A ruby gem for using the YO API