sakenote 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9afa506024e4311f67846b8bc10d66b17c4e202
+  data.tar.gz: 15fdff9bf8e3c2626231623a573ce76684f9808c
+SHA512:
+  metadata.gz: 3b5bf0df6c5a7eb0aed575ba1af9fe0ee5ac61d2d323e5053d75582efe3686f99fb1b124e65cea659af623e85dc3c176ee2ad33bb37c3df6968a3e3e5f850e89
+  data.tar.gz: 90498d6dba4c053fcd62c2948d7922b3d4c98ecec1b2dae2ec529b67a97f1b4e7af1ed485a7c718f60b7462b5a4ec20155164685901318c2cde62aa31fdffa07

data/.env.sample

@@ -0,0 +1 @@
+SAKENOTE_TOKEN=*******

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.env

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sakenote.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 fukayatsu
+
+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,72 @@
+# Sakenote
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sakenote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sakenote
+
+## Usage
+
+- [get access token](https://www.sakenote.com/access_tokens)
+- [Sakenote API v1 docs](http://docs.sakenote.apiary.io/)
+
+```ruby
+require 'sakenote'
+
+# initialize client
+client = Sakenote::Client.new('YOUR SAKENOTE TOKEN')
+
+# search Sake
+#   options:
+#     prefecture_code: 都道府県コード(integer)
+#     sake_name:       銘柄の名前(string)
+#     maker_name:      酒造の名前(string)
+#     page:            取得するページ番号(integer)
+search_result = client.sakes(sake_name: '雪の茅舎')
+puts search_result.num_pages #=> 1
+
+sake = search_result.list.first
+puts sake.identify_code #=> 'P002384'
+puts sake.name          #=> '雪の茅舎'
+puts sake.furigana      #=> 'ゆきのぼうしゃ'
+puts sake.alphabet      #=> 'yukinobousha'
+
+maker = sake.maker
+puts maker.name      #=> '齋彌酒造店'
+puts maker.postcode  #=> '036-8366'
+puts maker.address   #=> '秋田県由利本荘市石脇字石脇53'
+puts maker.url       #=> 'http://www.yukinobousha.jp/'
+
+# search Maker
+#   options:
+#     prefecture_code: 都道府県コード(integer)
+#     maker_name:      酒造の名前(string)
+#     page:            取得するページ番号(integer)
+search_result = client.makers(prefecture_code: 05) # 05: Akita (ISO 3166-2:JP)
+puts search_result.num_pages #=> 1
+
+maker = search_result.list[1]
+puts maker.name      #=> '阿桜酒造'
+puts maker.postcode  #=> '013-0041'
+puts maker.address   #=> '秋田県横手市大沢字西野67-2'
+puts maker.url       #=> 'http://www.azakura.co.jp/'
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sakenote.rb

@@ -0,0 +1,3 @@
+require "sakenote/version"
+require 'sakenote/client'
+

data/lib/sakenote/client.rb

@@ -0,0 +1,84 @@
+require 'faraday'
+require 'faraday_middleware'
+
+require 'sakenote/error'
+require 'sakenote/error/configuration_error'
+require 'sakenote/search_result'
+require 'sakenote/sake'
+require 'sakenote/maker'
+
+module Sakenote
+  class Client
+    def initialize(token)
+      if token.is_a?(String) && token.strip.length > 0
+        @token = token
+        @conn  = connection
+      else
+        raise Sakenote::Error::ConfigurationError
+      end
+    end
+
+    # https://www.sakenote.com/api/v1/sakes
+    def sakes(prefecture_code: nil, sake_name: nil, maker_name: nil, page: 1)
+      options = {
+        token:           @token,
+        prefecture_code: prefecture_code,
+        sake_name:       sake_name,
+        maker_name:      maker_name,
+        page:            page
+      }.select{ |k, v| !v.nil? }
+
+      response = @conn.get '/api/v1/sakes', options
+
+      num_pages = response.body['num_pages'].to_i
+      list      = response.body['sakes'].map { |s|
+        Sake.new(s['sake_name'],
+          identify_code: s['sake_identify_code'],
+          furigana:      s['sake_furigana'],
+          alphabet:      s['sake_alphabet'],
+          maker:         Maker.new(s['maker_name'],
+            postcode: s['maker_postcode'],
+            address:  s['maker_address'],
+            url:      s['maker_url']
+          )
+        )
+      }
+
+      SearchResult.new(list, num_pages)
+    end
+
+    # https://www.sakenote.com/api/v1/makers
+    def makers(prefecture_code: nil, maker_name: nil, page: 1)
+      options = {
+        token:           @token,
+        prefecture_code: prefecture_code,
+        maker_name:      maker_name,
+        page:            page
+      }.select{ |k, v| !v.nil? }
+
+      response = @conn.get '/api/v1/makers', options
+
+      num_pages = response.body['num_pages'].to_i
+      list      = response.body['makers'].map { |s|
+        Maker.new(s['maker_name'],
+          postcode: s['maker_postcode'],
+          address:  s['maker_address'],
+          url:      s['maker_url']
+        )
+      }
+
+      SearchResult.new(list, num_pages)
+    end
+
+    def connection
+      faraday = Faraday.new 'https://www.sakenote.com' do |conn|
+        conn.request  :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter  Faraday.default_adapter
+      end
+
+      faraday.headers[:user_agent] = "Sakenote/#{Sakenote::VERSION} (sakenote-rubygems/#{Sakenote::VERSION})"
+      faraday
+    end
+  end
+end

data/lib/sakenote/error.rb

@@ -0,0 +1,4 @@
+module Sakenote
+  class Error < StandardError
+  end
+end

data/lib/sakenote/error/configuration_error.rb

@@ -0,0 +1,8 @@
+require 'sakenote/error'
+
+module Sakenote
+  class Error
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/sakenote/maker.rb

@@ -0,0 +1,12 @@
+module Sakenote
+  class Maker
+    def initialize(name, postcode: nil, address: nil, url: nil)
+      @name     = name
+      @postcode = postcode
+      @address  = address
+      @url      = url
+    end
+
+    attr_reader :name, :postcode, :address, :url
+  end
+end

data/lib/sakenote/sake.rb

@@ -0,0 +1,13 @@
+module Sakenote
+  class Sake
+    def initialize(name, identify_code: nil, furigana: nil, alphabet: nil, maker: nil)
+      @name          = name
+      @identify_code = identify_code
+      @furigana      = furigana
+      @alphabet      = alphabet
+      @maker         = maker
+    end
+
+    attr_reader :name, :identify_code, :furigana, :alphabet, :maker
+  end
+end

data/lib/sakenote/search_result.rb

@@ -0,0 +1,10 @@
+module Sakenote
+  class SearchResult
+    def initialize(list, num_pages)
+      @list      = list
+      @num_pages = num_pages
+    end
+
+    attr_reader :list, :num_pages
+  end
+end

data/lib/sakenote/version.rb

@@ -0,0 +1,3 @@
+module Sakenote
+  VERSION = "0.0.1"
+end

data/memo.md

@@ -0,0 +1,8 @@
+# TODO
+- vcr
+- travis
+
+# DOING
+
+# DONE
+

data/sakenote.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sakenote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sakenote"
+  spec.version       = Sakenote::VERSION
+  spec.authors       = ["fukayatsu"]
+  spec.email         = ["fukayatsu@gmail.com"]
+  spec.description   = %q{Sakenote API client}
+  spec.summary       = %q{Sakenote API client}
+  spec.homepage      = "https://github.com/fukayatsu/sakenote"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "faraday", "~> 0.8.8"
+  spec.add_dependency "faraday_middleware", "~> 0.9.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "dotenv"
+end

data/spec/sakenote/client_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Sakenote::Client do
+  describe '#new' do
+    context "token is provided" do
+      it 'dose not raise error' do
+        expect{
+          Sakenote::Client.new('foobar')
+        }.to_not raise_error
+      end
+    end
+
+    context "when invalid token is provided" do
+      it "raises a ConfigurationError exception" do
+        expect {
+          Sakenote::Client.new(['foo', 'bar'])
+        }.to raise_exception(Sakenote::Error::ConfigurationError)
+      end
+    end
+
+    context "no token is provided" do
+      it "raises a ArgumentError exception" do
+        expect {
+          Sakenote::Client.new
+        }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+  describe '#sakes' do
+    before(:all) do
+      @client = Sakenote::Client.new(ENV['SAKENOTE_TOKEN'])
+    end
+
+    context 'with no options' do
+      before(:all) do
+        @sakes = @client.sakes
+      end
+
+      it 'contains list of sakes' do
+        expect(@sakes.list[0]).to be_a Sakenote::Sake
+      end
+
+      it 'contains num_pages' do
+        expect(@sakes.num_pages).to be > 0
+      end
+    end
+  end
+
+  describe '#makers' do
+    before(:all) do
+      @client = Sakenote::Client.new(ENV['SAKENOTE_TOKEN'])
+    end
+
+    context 'with no options' do
+      before(:all) do
+        @makers = @client.makers
+      end
+
+      it 'contains list of makers' do
+        expect(@makers.list[0]).to be_a Sakenote::Maker
+      end
+
+      it 'contains num_pages' do
+        expect(@makers.num_pages).to be > 0
+      end
+    end
+  end
+end

data/spec/sakenote_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Sakenote do
+  it 'VERSION' do
+    expect(Sakenote::VERSION).to eq('0.0.1')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'sakenote'
+require 'dotenv'
+Dotenv.load
+
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: sakenote
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- fukayatsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: dotenv
+  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'
+description: Sakenote API client
+email:
+- fukayatsu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .env.sample
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sakenote.rb
+- lib/sakenote/client.rb
+- lib/sakenote/error.rb
+- lib/sakenote/error/configuration_error.rb
+- lib/sakenote/maker.rb
+- lib/sakenote/sake.rb
+- lib/sakenote/search_result.rb
+- lib/sakenote/version.rb
+- memo.md
+- sakenote.gemspec
+- spec/sakenote/client_spec.rb
+- spec/sakenote_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/fukayatsu/sakenote
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Sakenote API client
+test_files:
+- spec/sakenote/client_spec.rb
+- spec/sakenote_spec.rb
+- spec/spec_helper.rb