yo4r 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff18458f2d2b26e75481e6ab10d5b03db40dd05b
+  data.tar.gz: 48c77da3433d9ecf03620f535c43b1f3a5e321fc
+SHA512:
+  metadata.gz: b8aa57a37f6eb184688c74a8c9b0da4ea8cb98942de86ce4bac7026350530439fe1e33bdcfa4737c1a33fd559c9120c42cd0a561e0a72ed31ab5bff8e07802a2
+  data.tar.gz: 741d55c399a7db23484ba8b811fdee7bf47401ba8883ff62d4857fb2c1037a229420e9fb0e73ba943e7e51b84e8d7ea08a7e239852eca5aa2e09ae9022479331

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tsukuru Tanimichi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# yo4r
+A Ruby interface to the Yo API.
+
+## Installation
+Install the gem with:
+
+```
+gem install yo4r
+```
+
+## Usage
+At first, get the API token at http://developer.justyo.co/ and then:
+
+```ruby
+require 'yo4r'
+
+# create a client
+client = Yo::Client.new(api_token: 'your_api_token')
+
+# Yo to someone
+client.yo(username: 'someone')
+
+# Yo to all subscribers
+client.yoall
+
+# count the number of your subscribers
+client.subscribers_count # => 42
+```
+
+That's all.
+
+## Exceptions
+- If `Yo::ClientError` is raised, the API token or username maybe invalid.
+- If `Yo::UnknownError` is raised, the Yo API server maybe down.
+
+## Contributing
+1. Fork it ( https://github.com/tanimichi/yo4r/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'unindent'
+
+if ENV['YO_API_TOKEN'] and ENV['YO_USER_NAME']
+  RSpec::Core::RakeTask.new(:spec)
+else
+  task :spec do
+    puts <<-EOS.unindent
+      In the case of this gem, I think testing with stubbing network access has no meaning!
+      At first, execute
+        export YO_USER_NAME='your_yo_username'
+        export YO_API_TOKEN='your_yo_api_token'
+      and then, execute `bundle exec rake spec` again!
+    EOS
+  end
+end
+
+task :default => :spec

data/lib/yo4r.rb

@@ -0,0 +1,4 @@
+require "yo4r/version"
+require 'yo4r/errors'
+require 'yo4r/http'
+require 'yo4r/client'

data/lib/yo4r/client.rb

@@ -0,0 +1,19 @@
+module Yo
+  class Client
+    def initialize(api_token: '')
+      @http = HTTP.new(api_token: api_token)
+    end
+
+    def yo(username: '')
+      @http.yo(username: username)
+    end
+
+    def yoall
+      @http.yoall
+    end
+
+    def subscribers_count
+      @http.subscribers_count
+    end
+  end
+end

data/lib/yo4r/errors.rb

@@ -0,0 +1,4 @@
+module Yo
+  ClientError     = Class.new(StandardError)
+  UnknownError    = Class.new(StandardError)
+end

data/lib/yo4r/http.rb

@@ -0,0 +1,33 @@
+require 'faraday'
+require 'json'
+
+module Yo
+  class HTTP
+    def initialize(api_token: nil)
+      @api_token = api_token
+      @faraday   = Faraday.new('http://api.justyo.co')
+    end
+
+    def yo(username: nil)
+      return true if access_api { @faraday.post('/yo/', api_token: @api_token, username: username) }
+    end
+
+    def yoall
+      access_api { @faraday.post('/yoall/', api_token: @api_token) }
+    end
+
+    def subscribers_count
+      access_api { @faraday.get('/subscribers_count/', api_token: @api_token) }
+    end
+
+    private def access_api
+      begin
+        params = JSON.parse(yield.body)
+      rescue Exception => e
+        raise UnknownError, e.message
+      end
+      raise ClientError, params['error'] if params['error']
+      params['result']
+    end
+  end
+end

data/lib/yo4r/version.rb

@@ -0,0 +1,3 @@
+module Yo4r
+  VERSION = "0.1.0"
+end

data/spec/client_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Yo::Client do
+  describe '#yo' do
+    context "with the valid api token" do
+      subject { Yo::Client.new(api_token: ENV['YO_API_TOKEN']) }
+      context "with the valid username" do
+        it "returns true" do
+          subject.yo(username: ENV['YO_USER_NAME']).should eq(true)
+        end
+      end
+
+      context 'with an invalid username' do
+        it 'raise Yo::ClientError' do
+          ->{ subject.yo(username: 'invalid_user_name') }.should raise_error(Yo::ClientError)
+        end
+      end
+    end
+
+    context 'with an invalid api token' do
+      subject { Yo::Client.new(api_token: 'invalid_api_token') }
+      it 'raise Yo::ClientError' do
+        ->{ subject.yo(username: ENV['YO_USER_NAME']) }.should raise_error(Yo::ClientError)
+      end
+    end
+
+    context 'when Yo API server is down' do
+      before  { Yo::HTTP.any_instance.stub(:yo).and_raise(Yo::UnknownError) }
+      subject { Yo::Client.new(api_token: 'invalid_api_token') }
+      it 'raise Yo::UnknownError' do
+        ->{ subject.yo(username: ENV['YO_USER_NAME']) }.should raise_error(Yo::UnknownError)
+      end
+    end
+  end
+
+  describe '#yoall' do
+    context 'with the valid api token' do
+      subject { Yo::Client.new(api_token: ENV['YO_API_TOKEN']) }
+      it "returns nil" do
+        subject.yoall.should eq(nil)
+      end
+    end
+
+    context 'with an invalid api token' do
+      subject { Yo::Client.new(api_token: 'invalid_api_token') }
+      it "returns nil" do
+        subject.yoall.should eq(nil)
+      end
+    end
+
+    context 'when Yo API server is down' do
+      before  { Yo::HTTP.any_instance.stub(:yoall).and_raise(Yo::UnknownError) }
+      subject { Yo::Client.new(api_token: 'invalid_api_token') }
+      it 'raise Yo::UnknownError' do
+        ->{ subject.yoall }.should raise_error(Yo::UnknownError)
+      end
+    end
+  end
+
+  describe '#subscribers_count' do
+    context 'with the valid api token' do
+      subject { Yo::Client.new(api_token: ENV['YO_API_TOKEN']) }
+      it "returns Fixnum" do
+        subject.subscribers_count.kind_of?(Fixnum).should eq(true)
+      end
+    end
+
+    context 'with an invalid api token' do
+      subject { Yo::Client.new(api_token: 'invalid_api_token') }
+      it 'raise Yo::ClientError' do
+        ->{ subject.subscribers_count }.should raise_error(Yo::ClientError)
+      end
+    end
+
+    context 'when Yo API server is down' do
+      before  { Yo::HTTP.any_instance.stub(:subscribers_count).and_raise(Yo::UnknownError) }
+      subject { Yo::Client.new(api_token: ENV['YO_API_TOKEN']) }
+      it 'raise Yo::UnknownError' do
+        ->{ subject.subscribers_count }.should raise_error(Yo::UnknownError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'yo4r'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |config|
+    config.syntax = [:should]
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :should
+  end
+end

data/yo4r.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yo4r/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yo4r"
+  spec.version       = Yo4r::VERSION
+  spec.authors       = ["Tsukuru Tanimichi"]
+  spec.email         = ["tanimichi@outlook.jp"]
+  spec.summary       = 'A Ruby interface to the Yo API.'
+  spec.description   = 'A Ruby interface to the Yo API.'
+  spec.homepage      = "https://github.com/tanimichi/yo4r"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0.0'
+  spec.add_development_dependency "unindent"
+  spec.add_dependency 'faraday', '~> 0.9.0'
+  spec.required_ruby_version = '>= 2.1'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: yo4r
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tsukuru Tanimichi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-03 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: unindent
+  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.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: A Ruby interface to the Yo API.
+email:
+- tanimichi@outlook.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yo4r.rb
+- lib/yo4r/client.rb
+- lib/yo4r/errors.rb
+- lib/yo4r/http.rb
+- lib/yo4r/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- yo4r.gemspec
+homepage: https://github.com/tanimichi/yo4r
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: A Ruby interface to the Yo API.
+test_files:
+- spec/client_spec.rb
+- spec/spec_helper.rb