hey 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTdjM2UzNWE0NTgwMWRhNWM0MGM2ZTgwOTc2NDk1NDFjZDQzYzQxNw==
+    ZmY2YmFlMzU2NzVlZjJmNTA0ODZmODFhMzg4YmE5MjNlMGJhZmZiYg==
   data.tar.gz: !binary |-
-    ZmUyYTdjZWZhNTg2OTkzN2QxYTY2N2Y4Yzc5YjNhYTQzMTk0NDVmYQ==
+    Yjk4MWVjYzJjZmUyZDIyOTMyNDhkMmIwZTNiNWFlNDQxNmQ1OWU2OQ==
 SHA512:
   metadata.gz: !binary |-
-    NTk2NDk1NjExNmFmMDBmMDdkYjEzZDMxZWMzMWYwNTc1YWEwNzIyYjYwYzUz
-    Y2RiYzA2ZGFkNGRiODc5NzE4YTUxZWVmNGMzYjllYjQzOGRhNzYxNzdkNTY0
-    MWJmOWNiZjFiZGQxZGYwNGIyNjljZDE3NmZmZmM5MTQ4MzIyODk=
+    YzA2NzQwNTRkZWY0M2FhNGJiODk1MjQzYTFjZWNmNmE4ZTE2ZWFiZjIxNzhk
+    OGMzM2VkZmYzMmRhYWFlZDFiYjYzN2IxYTkyNmM0MjQ3MDIwMGI5MDE3YmVm
+    OWRjMWI0NzBkNzZkNGE2YzdjOWI4YWY3YmQxNDkzMDQyZDhkY2Q=
   data.tar.gz: !binary |-
-    NjdlNjgxYTkwMjdmNmExMzI0ZDE2NmY1NzhjMTAzNGNlNGFlYmY0MDlkY2Rj
-    ODMzYTcyMGMwZTg3ZmViYjVjMTBlYWE3NjliMDRmN2VhYzFlMjJiY2UyOTZm
-    YjhhMTEyNTU2MWZiOWJiNDNlZjNjY2E1YTIwNWE4ZDkwMmMwYWI=
+    N2EyOTY0YjlkMGI5OWIzZjUwNjRmMmRmYWEwZTIzNWYyM2VjYjgzZDgzZWNl
+    ZTk0NzYyM2M4NmQxMDYyMTliYWU1MGJjYjNmMjAyMWNkOWM5ZWQ4OWYwMjky
+    MzA5YWQ0MWFhNmZkYmI0NTA1ZWQ1NDMxOTZiNGFkZmE3ODAxZGQ=

data/README.md

@@ -4,6 +4,8 @@ A Ruby library for sending yo's from [Yo](http://justyo.co).
 
 [github.com/jackjennings/hey](http://github.com/jackjennings/hey)
 
+[![Gem Version](https://badge.fury.io/rb/hey.svg)](http://badge.fury.io/rb/hey) [![Code Climate](https://codeclimate.com/github/jackjennings/hey.png)](https://codeclimate.com/github/jackjennings/hey) [![Build Status](https://travis-ci.org/jackjennings/hey.svg)](https://travis-ci.org/jackjennings/hey)
+
 # Installation
 
 ```
@@ -12,13 +14,22 @@ gem install hey
 
 # Usage
 
+First [get an API token](http://yoapi.justyo.co).
+
+Then:
+
 ```ruby
 Hey.api_token = '3858f62230ac3c915f300c664312c63f'
 Hey::Yo.all
 
-# or set api_token on a Yo instance
+# or set api_token on a Yo instance:
 
 Hey::Yo.new(api_token: '3858f62230ac3c915f300c664312c63f').all
+
+# or Yo a specific user:
+
+Hey::Yo.user "WORLDCUP" # or...
+Hey::Yo.new(api_token: '3858f62230ac3c915f300c664312c63f').user "WORLDCUP"
 ```
 
-That's it!
+That's it!

data/Rakefile

@@ -1,5 +1,13 @@
 require 'rake'
 require 'rake/testtask'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hey'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs = ["test", "lib"]

data/lib/hey.rb

@@ -6,6 +6,7 @@ module Hey
   
   class MissingAPITokenError < StandardError; end
   class InvalidAPITokenError < StandardError; end
+  class NoSuchUserError < StandardError; end
   
   def self.api_token= value
     @api_token = value

data/lib/hey/version.rb

@@ -1,3 +1,3 @@
 module Hey
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/hey/yo.rb

@@ -1,29 +1,72 @@
 module Hey
+  # Sends requests to the Yo API endpoint.
   class Yo
     
+    # (Optional) Should be set if an API token hasn't be set
+    # on the Hey module.
     attr_accessor :api_token
     
+    # Optionally accepts a hash containing an API token.
+    # Defaults to the API token set on the Hey module.
+    # 
+    #  Hey::Yo.new api_token: '3858f62230ac3c915f300c664312c63f'
     def initialize options = {}
       @api_token = options[:api_token] || Hey.api_token
     end
     
+    # Sends a request to the +yoall+ endpoint.
+    # Raises a +MissingAPITokenError+ error if an API token
+    # hasn't been set on the Hey module or Yo instance.
     def all
       raise MissingAPITokenError unless api_token
-      post_request('yoall')
+      post_request 'yoall'
     end
     
+    # Sends a request to a user using the +yo+ endpoint.
+    # Raises a +MissingAPITokenError+ error if an API token
+    # hasn't been set on the Hey module or Yo instance.
+    #
+    #  Hey::Yo.new.user "worldcup"
+    def user name
+      raise MissingAPITokenError unless api_token
+      post_request 'yo', username: name
+    end
+    
+    # Sends a request to the +yoall+ endpoint using the
+    # API token set on the Hey module.
     def self.all
       new.all
     end
     
+    # Sends a request to a user using the +yo+ endpoint.
+    # Raises a +MissingAPITokenError+ error if an API token
+    # hasn't been set on the Hey module.
+    #
+    #  Hey::Yo.user "worldcup"
+    def self.user name
+      new.user name
+    end
+    
     private
     
-    def post_request(method)
+    def post_request method, params = {} #:nodoc:
+      params = params.merge api_token: api_token
       uri = URI("http://api.justyo.co/#{method}/")
-      request = Net::HTTP.post_form uri, api_token: api_token
-      raise InvalidAPITokenError if JSON.parse(request.body)["code"] == 141
+      request = Net::HTTP.post_form uri, params
+      raise_for_invalid_code! request
       request
     end
     
+    def raise_for_invalid_code! request #:nodoc:
+      response = JSON.parse(request.body)
+      return unless response["code"] && response["code"] == 141
+      case response["error"]
+      when "NO SUCH USER"
+        raise NoSuchUserError 
+      else
+        raise InvalidAPITokenError
+      end
+    end
+    
   end
 end

data/test/yo_test.rb

@@ -28,6 +28,16 @@ class YoTest < Minitest::Test
     assert_sends_yo {Hey::Yo.all}
   end
   
+  def test_user_sends_api_request
+    yo = Hey::Yo.new(api_token: 'foo')
+    assert_sends_yo {yo.user('YOJOBS')}
+  end
+  
+  def test_class_method_user_sends_api_request
+    Hey.api_token = 'foo'
+    assert_sends_yo {Hey::Yo.user('YOJOBS')}
+  end
+  
   def test_raises_no_api_token_error
     Hey.api_token = nil
     yo = Hey::Yo.new
@@ -37,10 +47,13 @@ class YoTest < Minitest::Test
   end
   
   def assert_sends_yo(&block)
-    mock = MiniTest::Mock.new
-    mock.expect(:post_form, nil, [URI, Hash])
-    Net.stub_const(:HTTP, mock, &block)
-    assert mock.verify
+    mock_response = Net::HTTPResponse.new('1.1', '201', 'CREATED')
+    mock_response.stub(:read_body, "{\"code\": 201}") do
+      mock = MiniTest::Mock.new
+      mock.expect(:post_form, mock_response, [URI, Hash])
+      Net.stub_const(:HTTP, mock, &block)
+      assert mock.verify
+    end
   end
   
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jack Jennings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
 description: Sends a yo to your yo followers
 email: j@ckjennin.gs
 executables: []