hey 1.3.0 → 1.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTU2MWYxNDU2NzFmYTY1MzFlZTcwZDY4ZjU4Y2ZkMzBjZWQ4Mjc5Yg==
+    YTExZTdlZDQzYTM3MzllMzNhZDI0YjU1MTljYmY0M2Q1MGMzZmY4MQ==
   data.tar.gz: !binary |-
-    YTNiYTliNzc0ODEyZDMxMTdlNTdlYWIxN2FhMzUxOGEyNTE1ZjQ1MQ==
+    ZjFmZTY3Mzg5MDliOTQ1ZDdhMzViYzEyYmFkOTUzNjBmZDBjMzAyYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZjQ3ZjI4NDMxZjIyM2NhMWFkYzRmZmNmZTFmNGQ3MDhhYjJhYjBiYjcyNjQ2
-    MjExNGJlNDFhMWVmYjdlYWFlYTExNjNhYzlkMzQ0YjM5ZTdmYjBmMDEwNWYy
-    NzM1ZjUxMWQ5ZDQyYWI5ZmEyY2I3YmJhYTE3NjUzZWVjNmRjZjY=
+    NWFlNjJlNGVkYTA2NDIwZTc5MDdlMmNhZDE0NTFjMTE4ZjViNDYyMDY4OTMy
+    ZGI2MWZiNzkyZTJjYTU2OWZjMzM5NDU0NjBjNzM3NmFhZTY4YjI0MTJhNDRk
+    N2I5M2VlMmFhYWU1YjgzZTkwMmI2ZGZjZDJhMGEzZWI5YjQyODk=
   data.tar.gz: !binary |-
-    NjkzYzQ2MjVmMjFkMmNkNzc0NWZlODMwOGZiYzMwNGM1ZDlhMGVmYzAyYWY3
-    NzIxNDJjMDI3ODEzOGE3NzcxODIwNmI3NGIxM2M3MTFkZTUzNmI3ZTE0YWYx
-    YWZkODNmMTU1ZThmNzk2OWQ5MjQ3Mjk4NGRlMzc2ZDM0MjZjZmI=
+    ZWZhNThhNTE2MTQzNDFjNjU5ZDdhYjEwOTUwYWY2Yzg2NWZkOTg2NzM2ZjY5
+    YjRmZDgzMDQ3MzkyMjI1ZDYyMjg2ZTdmMWE1MDBiNDMzNWQ3YjkyZDM3YWY4
+    NzY2NDI1MjAxMjg5MzliNjE4MzgyMmU5OTYzMDNkZWMwNzBjZmY=

data/README.md

@@ -16,23 +16,62 @@ gem install hey
 
 First [get an API token](http://yoapi.justyo.co).
 
-Then:
+There are two ways of setting you API token, depending on your requirements. If your program is only working with a single API token, you can set it in an initializer or at the start of your script.
 
 ```ruby
 Hey.api_token = "3858f62230ac3c915f300c664312c63f"
-Hey::Yo.all # or yo a specific user...
-Hey::Yo.user "WORLDCUP"
-Hey::Subscriber.count
+```
+
+If you need to use multiple API tokens, any `hey` class will accept an `api_token` on initialization.
 
-# Additional parameters can be sent to Yo endpoints.
-Hey::Yo.all link: "http://justyo.co"
-Hey::Yo.user "WORLDCUP", link: "http://justyo.co"
+```ruby
+Hey::Yo.new api_token: "3858f62230ac3c915f300c664312c63f" 
+```
 
-# or set api_token on a Yo instance:
+An API token set when initializing an object takes precidence over the API token set on the `Hey` module.
 
-yo = Hey::Yo.new api_token: "3858f62230ac3c915f300c664312c63f"
+## Yo All
+
+Sends a yo to all of the account's subscribers.
+
+```ruby
+Hey::Yo.all
+# or
+yo = Hey::Yo.new api_token: "..."
 yo.all
+```
+
+Accepts either `link` or `location` in a hash of parameters (optional).
+
+```ruby
+Hey::Yo.all link: "https://github.com/jackjennings/hey"
+```
+
+## Yo User
+
+Sends a yo to a specific user.
+
+```ruby
+Hey::Yo.user "WORLDCUP"
+# or
+yo = Hey::Yo.new api_token: "..."
 yo.user "WORLDCUP"
+```
+
+Accepts either `link` or `location` in a hash of parameters (optional).
+
+```ruby
+Hey::Yo.user "WORLDCUP" link: "https://github.com/jackjennings/hey"
+```
+
+## Subscriber Count
+
+Returns the number of subscribers.
+
+```ruby
+Hey::Subscriber.count
+# or
+yo = Hey::Yo.new api_token: "3858f62230ac3c915f300c664312c63f"
 yo.subscribers.count
 ```
 

data/lib/hey/dispatcher.rb

@@ -1,5 +1,4 @@
-require 'json'
-require 'net/http'
+require 'hey/request'
 
 module Hey
   class Dispatcher
@@ -13,45 +12,38 @@ module Hey
     # 
     #  Hey::Yo.new api_token: '3858f62230ac3c915f300c664312c63f'
     def initialize options = {}
-      @api_token = options[:api_token] || Hey.api_token
+      @api_token = options[:api_token]
     end
     
-    private
-    
-    def uri route, data = nil #:nodoc:
-      URI("http://api.justyo.co/#{route}/#{data}")
+    # Returns the API token to be used when making requests. This will either
+    # be the api_token set on initialization or the token set on the Hey
+    # module itself.
+    def api_token
+      @api_token || Hey.api_token
     end
     
+    private
+    
     def get route #:nodoc:
-      response = Net::HTTP.get_response uri(route, "?api_token=#{api_token}")
-      raise_for_invalid_code! response
-      response
+      request :get, route
     end
     
     def post route, params = {} #:nodoc:
-      params = params.merge api_token: api_token
-      response = Net::HTTP.post_form uri(route), params
-      raise_for_invalid_code! response
-      response
+      request :post, route, params
     end
     
-    def raise_for_missing_api_token! #:nodoc:
-      raise MissingAPITokenError unless api_token
+    def request method, route, params = {} #:nodoc:
+      merge_api_token! params
+      Request.of_type(method).new route, params
     end
     
-    def raise_for_invalid_code! response #:nodoc:
-      body = get_response_body(response)
-      return unless body && body["code"] == 141
-      case body["error"]
-      when "NO SUCH USER"
-        raise NoSuchUserError 
-      else
-        raise InvalidAPITokenError
-      end
+    def merge_api_token! params #:nodoc:
+      raise_for_missing_api_token!
+      params.merge! api_token: api_token
     end
     
-    def get_response_body request #:nodoc:
-      request && request.body ? JSON.parse(request.body) : nil
+    def raise_for_missing_api_token! #:nodoc:
+      raise MissingAPITokenError unless api_token
     end
     
   end

data/lib/hey/request.rb

@@ -0,0 +1,12 @@
+require 'hey/request/get'
+require 'hey/request/post'
+
+module Hey
+  module Request
+
+    def self.of_type method
+      self.const_get method.to_s.capitalize
+    end
+
+  end
+end

data/lib/hey/request/base.rb

@@ -0,0 +1,50 @@
+require 'json'
+require 'net/http'
+
+module Hey
+  module Request
+    class Base
+      
+      URL = "http://api.justyo.co"
+      ERROR_CODE = 141
+      
+      attr_accessor :response
+      
+      def initialize route, params = {}
+        @response = send_request route, params
+        raise_for_invalid_code!
+      end
+      
+      def uri route, data = nil #:nodoc:
+        URI([URL, route, data].join("/"))
+      end
+      
+      def raise_for_invalid_code! #:nodoc:
+        return unless has_error?
+        case error_message
+        when "NO SUCH USER"
+          raise NoSuchUserError 
+        else
+          raise InvalidAPITokenError
+        end
+      end
+      
+      def has_error?
+        json && json["code"] == ERROR_CODE
+      end
+      
+      def error_message
+        json["error"]
+      end
+
+      def get_response_body request #:nodoc:
+        request && request.body ? JSON.parse(request.body) : nil
+      end
+      
+      def json
+        @json ||= get_response_body @response
+      end
+      
+    end
+  end
+end

data/lib/hey/request/get.rb

@@ -0,0 +1,20 @@
+require 'hey/request/base'
+
+module Hey
+  module Request
+    class Get < Base
+      
+      def send_request route, params
+        Net::HTTP.get_response uri(route, url_params(params))
+      end
+      
+      def url_params params
+        parts = params.reduce([]) do |arr, param|
+          arr << "#{param[0]}=#{param[1]}"
+        end
+        "?" << parts.join("&") if parts.any?
+      end
+      
+    end
+  end
+end

data/lib/hey/request/post.rb

@@ -0,0 +1,13 @@
+require 'hey/request/base'
+
+module Hey
+  module Request
+    class Post < Base
+      
+      def send_request route, params
+        Net::HTTP.post_form uri(route), params
+      end
+      
+    end
+  end
+end

data/lib/hey/subscriber.rb

@@ -8,10 +8,8 @@ module Hey
     # Raises a +MissingAPITokenError+ error if an API token
     # hasn't been set on the Hey module or Yo instance.
     def count
-      raise_for_missing_api_token!
-      response = get 'subscribers_count'
-      body = get_response_body response
-      body['count']
+      request = get 'subscribers_count'
+      request.json['count']
     end
     
     # Sends a request to the +subscribers_count+ endpoint using the

data/lib/hey/version.rb

@@ -1,3 +1,3 @@
 module Hey
-  VERSION = "1.3.0"
-end
+  VERSION = "1.3.1"
+end

data/lib/hey/yo.rb

@@ -11,7 +11,6 @@ module Hey
     # Accepts an optional hash of additional parameters to
     # send with the request.
     def all params = {}
-      raise_for_missing_api_token!
       post 'yoall', params
     end
     
@@ -24,7 +23,6 @@ module Hey
     #  Hey::Yo.new.user "worldcup"
     #  Hey::Yo.new.user "worldcup", link: "http://example.com"
     def user name, params = {}
-      raise_for_missing_api_token!
       params.merge! username: name
       post 'yo', params
     end

data/test/dispatcher_test.rb

@@ -4,7 +4,6 @@ require 'hey/dispatcher'
 class DispatcherTest < Minitest::Test
   
   def teardown
-    WebMock.reset!
     Hey.api_token = nil
   end
   
@@ -19,19 +18,25 @@ class DispatcherTest < Minitest::Test
     assert_equal 'bar', dispatcher.api_token
   end
   
-  def test_get_request
-    stub_get = stub_request(:get, "http://api.justyo.co/bar/?api_token=foo")
-    dispatcher = Hey::Dispatcher.new api_token: 'foo'
-    dispatcher.send :get, 'bar'
-    assert_requested stub_get
+  def test_raises_for_absent_api_token
+    assert_raises Hey::MissingAPITokenError do
+      dispatcher = Hey::Dispatcher.new
+      dispatcher.merge_api_token! {}
+    end
   end
   
-  def test_post_request
-    stub_post = stub_request(:post, "http://api.justyo.co/bar/")
-      .with(:body => {"api_token"=>"foo"})
+  def test_merges_api_token
     dispatcher = Hey::Dispatcher.new api_token: 'foo'
-    dispatcher.send :post, 'bar'
-    assert_requested stub_post
+    params = {}
+    dispatcher.send(:merge_api_token!, params)
+    assert 'foo', params[:api_token]
+  end
+  
+  def test_raises_for_absent_api_token
+    assert_raises Hey::MissingAPITokenError do
+      dispatcher = Hey::Dispatcher.new
+      dispatcher.send(:merge_api_token!, {})
+    end
   end
   
-end
+end

data/test/request_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+require 'hey/request'
+
+class RequestTest < Minitest::Test
+  
+  def teardown
+    WebMock.reset!
+    Hey.api_token = nil
+  end
+  
+  def test_get_request
+    stub_get = stub_request(:get, "http://api.justyo.co/bar/")
+    request = Hey::Request::Get.new 'bar'
+    assert_requested stub_get
+  end
+  
+  def test_get_request_with_params
+    stub_get = stub_request(:get, "http://api.justyo.co/bar/?foo=baz")
+    request = Hey::Request::Get.new 'bar', foo: 'baz'
+    assert_requested stub_get
+  end
+  
+  def test_post_request
+    stub_post = stub_request(:post, "http://api.justyo.co/bar/")
+    dispatcher = Hey::Request::Post.new 'bar'
+    assert_requested stub_post
+  end
+  
+  def test_post_request_with_params
+    stub_post = stub_request(:post, "http://api.justyo.co/bar/")
+      .with(:body => {"foo"=>"baz"})
+    dispatcher = Hey::Request::Post.new 'bar', foo: 'baz'
+    assert_requested stub_post
+  end
+  
+  def test_of_type_get
+    assert_equal Hey::Request::Get, Hey::Request.of_type(:get)
+  end
+  
+  def test_of_type_post
+    assert_equal Hey::Request::Post, Hey::Request.of_type(:post)
+  end
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hey
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Jack Jennings
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -76,11 +76,16 @@ files:
 - Rakefile
 - lib/hey.rb
 - lib/hey/dispatcher.rb
+- lib/hey/request.rb
+- lib/hey/request/base.rb
+- lib/hey/request/get.rb
+- lib/hey/request/post.rb
 - lib/hey/subscriber.rb
 - lib/hey/version.rb
 - lib/hey/yo.rb
 - test/dispatcher_test.rb
 - test/hey_test.rb
+- test/request_test.rb
 - test/subscriber_test.rb
 - test/test_helper.rb
 - test/yo_test.rb
@@ -111,6 +116,7 @@ summary: Sends a yo
 test_files:
 - test/dispatcher_test.rb
 - test/hey_test.rb
+- test/request_test.rb
 - test/subscriber_test.rb
 - test/test_helper.rb
 - test/yo_test.rb