yo_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78689d15bfac530539523a79d1ff1b65b7ec300e
-  data.tar.gz: 84bda1bec35c29c08d698a14671832175f7d8eab
+  metadata.gz: 8e3216adee4b8bf0b39ee3d5fb1f502e3f245903
+  data.tar.gz: b8a67600c9402e8869a0710c2f47cca422e8c09a
 SHA512:
-  metadata.gz: c27e20590014c4e3291bf170ab86b7aca3a5b207baa1171ee3724b03590c223c0abb017d1987572cecd95aca36d8683f2b486b85120d5526c9facf54ff05fa0f
-  data.tar.gz: 55f94566690d09a603149ba315697b17f87cbcf333fc326c676a4906c0fc2d613ccf2f692ee371d4e17afb2354ef59282a97f3179eb185faa229a549d06bfbae
+  metadata.gz: f2cb40dcf33f4ea81b7ac923cc12d1e7f7a836f9a37a70f1c6f2da4a78334e715b6617bf63bb028c3e55e6102160928e6f4263e3830caca79099fae1c2656272
+  data.tar.gz: 308199571d0deadf965f77a205acd041f701b8600190fd97c2c93158c7ff990a90455f84f2a126245c5d339143f55dd00bf0f742f17d8bb865ece9aa33d3d669

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
+  - 1.9.3
+  - 2.0.0
   - 2.1.2

data/README.md

@@ -1,19 +1,26 @@
-# YoClient [![Build Status](https://travis-ci.org/youcune/yo_client.svg?branch=master)](https://travis-ci.org/youcune/yo_client)
+# YoClient
 
 is a Ruby client of [Yo](http://www.justyo.co/).
+[![Build Status](https://travis-ci.org/youcune/yo_client.svg?branch=master)](https://travis-ci.org/youcune/yo_client)
+[![Coverage Status](https://coveralls.io/repos/youcune/yo_client/badge.png)](https://coveralls.io/r/youcune/yo_client)
+
+## Requirements
+
+* Ruby 1.9+ (Tested on Ruby 1.9.3, 2.0.0, 2.1.2)
+* [Yo API Account](http://dev.justyo.co/)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```
-gem 'yo_client', github: 'youcune/yo_client'
+gem 'yo_client'
 ```
 
 And then execute:
 
 ```
-$ bundle
+$ bundle install
 ```
 
 ## Usage
@@ -21,17 +28,24 @@ $ bundle
 ```
 client = YoClient::Client.new(API_TOKEN)
 
-# Send A Yo To All Subscribers
+# Yo all subscribers
 client.yoall
 
-# Yo Individual Usernames
-# Note that USERNAME will be upcased and sent to API
+# Yo specific user
+# Note that USERNAME will be upcased before sending to API
 client.yo(USERNAME)
 
 # Count Total Subscribers
 client.subscribers_count # -> 5
 ```
 
+### Error Handling
+
+* `YoClient::ConnectionError` is risen if the connection has failed.
+* `YoClient::ClientError` is risen if the connection has succeeded but API returned error.
+
+At the date of 13th July, even if API results in failure, it sometimes behaves as if it succeed. In this case, YoClient cannot tell succeeded or not.
+
 ## Contributing
 
 1. Fork it ( https://github.com/youcune/yo_client/fork )
@@ -40,3 +54,12 @@ client.subscribers_count # -> 5
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
+## Yo the author
+
+[Yo YOUCUNE](http://justyo.co/YOUCUNE), author of YoClient, if you ...
+
+* like YoClient
+* dislike YoClient
+* have any ideas about YoClient
+
+Thanks.

data/lib/yo_client.rb

@@ -5,7 +5,7 @@ require 'faraday_middleware'
 module YoClient
   class Client
     # Constructor
-    # @param [String] token Yo API Token
+    # @param [String] api_token Yo API Token
     def initialize(api_token)
       @api_token = api_token
       @faraday = Faraday.new(url: 'http://api.justyo.co') do |faraday|
@@ -16,26 +16,58 @@ module YoClient
     end
 
     # Yo to all subscribers
+    # @return [Boolean] if request has succeed
     def yoall
-      @faraday.post '/yoall/', token_hash
+      response = connection_wrapper {
+        @faraday.post '/yoall/', token_hash
+      }
+      response.success?
     end
 
     # Yo to specific user
-    # @param [String] username
+    # @param [String] username usename to send yo
+    # @return [Boolean] if request has succeed
     def yo(username)
-      @faraday.post '/yo/', token_hash.merge(username: username.upcase)
+      response = connection_wrapper {
+        @faraday.post '/yo/', token_hash.merge(username: username.upcase)
+      }
+      response.success?
     end
 
     # Get a number of subscribers
     # @return [Integer] number of subscribers
     def subscribers_count
-      response = @faraday.get '/subscribers_count/', token_hash
+      response = connection_wrapper {
+        @faraday.get '/subscribers_count/', token_hash
+      }
       response.body['result']
     end
 
     private
+      # Connect with error handling
+      # @param [Proc] block
+      def connection_wrapper(&block)
+        begin
+          response = block.call
+          raise ClientError.new(response.body['error']) if response.body.has_key?('error')
+        rescue Faraday::ParsingError => e
+          # Has gotten a response, but it is not formatted with JSON
+          raise ClientError.new(e.message)
+        rescue Faraday::ClientError => e
+          # Failed to build a connection
+          raise ConnectionError.new(e.message)
+        end
+
+        response
+      end
+
+      # Returns hash for every request
+      # @return [Hash] hash for every request
       def token_hash
         { api_token: @api_token }
       end
   end
+
+  class ConnectionError < StandardError; end
+  class ClientError < StandardError; end
 end

data/lib/yo_client/version.rb

@@ -1,3 +1,3 @@
 module YoClient
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'yo_client'
-require 'pry'
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end

data/spec/yo_client_spec.rb

@@ -18,8 +18,8 @@ describe YoClient do
       it 'hooks POST /yoall/' do
         expect_any_instance_of(Faraday::Connection).to(
           receive(:post)
-          .with('/yoall/', { api_token: 'test' })
-          .and_return(double('yo', body: {}))
+            .with('/yoall/', { api_token: 'test' })
+            .and_return(double('yo', body: {}, success?: true))
         )
         @client.yoall
       end
@@ -29,8 +29,8 @@ describe YoClient do
       it 'hooks POST /yo/' do
         expect_any_instance_of(Faraday::Connection).to(
           receive(:post)
-          .with('/yo/', { api_token: 'test', username: 'YOUCUNE' })
-          .and_return(double('yo', body: {}))
+            .with('/yo/', { api_token: 'test', username: 'YOUCUNE' })
+            .and_return(double('yo', body: {}, success?: true))
         )
         @client.yo('youcune')
       end
@@ -40,7 +40,6 @@ describe YoClient do
       it 'hooks GET /subscribers_count/' do
         expect_any_instance_of(Faraday::Connection).to(
           receive(:get)
-            .with('/subscribers_count/', { api_token: 'test' })
             .and_return(double('subscribers_count', body: { 'result' => 5 }))
         )
         expect(@client.subscribers_count).to eq 5

data/yo_client.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = YoClient::VERSION
   spec.authors       = ['Yu Nakanishi']
   spec.email         = ['you@nakanishi.email']
-  spec.summary       = 'Yo Client Library'
-  spec.description   = 'Yo Client Library'
+  spec.summary       = 'Yo (http://www.justyo.co/) Ruby Client'
+  spec.description   = 'Yo (http://www.justyo.co/) Ruby Client'
   spec.homepage      = 'https://github.com/youcune/yo_client'
   spec.license       = 'MIT'
 
@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'coveralls'
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.0'
+  spec.required_ruby_version = '>= 1.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yo_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yu Nakanishi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-12 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,18 +42,18 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -70,37 +70,38 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Yo Client Library
+        version: 0.9.0
+description: Yo (http://www.justyo.co/) Ruby Client
 email:
 - you@nakanishi.email
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -125,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -136,7 +137,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Yo Client Library
+summary: Yo (http://www.justyo.co/) Ruby Client
 test_files:
 - spec/spec_helper.rb
 - spec/yo_client_spec.rb