Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
youcune committed Jul 12, 2014
0 parents commit 53983fe
Show file tree
Hide file tree
Showing 12 changed files with 226 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
*.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
/vendor/bundle
2 changes: 2 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
--format documentation
--color
3 changes: 3 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
language: ruby
rvm:
- 2.1.2
4 changes: 4 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in yo_client.gemspec
gemspec
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Copyright (c) 2014 youcune

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.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# YoClient

is a Ruby client of [Yo](http://www.justyo.co/).

## Installation

Add this line to your application's Gemfile:

```
gem 'yo_client', github: 'youcune/yo_client'
```

And then execute:

```
$ bundle
```

## Usage

```
client = YoClient::Client.new('API_TOKEN')
# Send A Yo To All Subscribers
client.yoall
# Yo Individual Usernames
# Note that USERNAME will be upcased and send to API
client.yo(USERNAME)
# Count Total Subscribers
client.subscribers_count # -> 5
```

## Contributing

1. Fork it ( https://github.com/[my-github-username]/yo_client/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
7 changes: 7 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec

41 changes: 41 additions & 0 deletions lib/yo_client.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
require 'yo_client/version'
require 'faraday'
require 'faraday_middleware'

module YoClient
class Client
# Constructor
# @param [String] token Yo API Token
def initialize(api_token)
@api_token = api_token
@faraday = Faraday.new(url: 'http://api.justyo.co') do |faraday|
faraday.request :url_encoded
faraday.response :json
faraday.adapter :net_http
end
end

# Yo to all subscribers
def yoall
@faraday.post '/yoall/', token_hash
end

# Yo to specific user
# @param [String] username
def yo(username)
@faraday.post '/yo/', token_hash.merge(username: username.upcase)
end

# Get a number of subscribers
# @return [Integer] number of subscribers
def subscribers_count
response = @faraday.get '/subscribers_count/', token_hash
response.body['result']
end

private
def token_hash
{ api_token: @api_token }
end
end
end
3 changes: 3 additions & 0 deletions lib/yo_client/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module YoClient
VERSION = '0.0.1'
end
3 changes: 3 additions & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
require 'yo_client'
require 'pry'
50 changes: 50 additions & 0 deletions spec/yo_client_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
require 'spec_helper'

describe YoClient do
it 'has a version number' do
expect(YoClient::VERSION).not_to be nil
end

it 'can create instance' do
expect(YoClient::Client.new('test')).to be_an_instance_of(YoClient::Client)
end

describe 'Instance of YoClient::Client' do
before do
@client = YoClient::Client.new('test')
end

describe '#yoall' 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: {}))
)
@client.yoall
end
end

describe '#yo' 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: {}))
)
@client.yo('youcune')
end
end

describe '#subscribers_count' 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
end
end
end
end
27 changes: 27 additions & 0 deletions yo_client.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'yo_client/version'

Gem::Specification.new do |spec|
spec.name = 'yo_client'
spec.version = YoClient::VERSION
spec.authors = ['Yu Nakanishi']
spec.email = ['[email protected]']
spec.summary = 'Yo Client Library'
spec.description = 'Yo Client Library'
spec.homepage = 'https://github.com/youcune/yo_client'
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'
spec.add_development_dependency 'pry-byebug'
spec.add_dependency 'faraday'
spec.add_dependency 'faraday_middleware'
end

0 comments on commit 53983fe

Please sign in to comment.