docomoru 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8938cee1dc86c5fcbb4b03212e03bc8796edf776
-  data.tar.gz: 219bb80f68c6ab072efaeac56d9413c0b8da7bed
+  metadata.gz: 980fdc8d5e4becacc3c352f09ba54c4911427e60
+  data.tar.gz: 2d9dd4b4ec00780c292db47287a898590b64568f
 SHA512:
-  metadata.gz: 9f3e7b75bc937acb886709466ce14a1c7a34f4672d06320da05f524dd9b943abc446c1b9ebe5c4d4858dd25788f55e2e6decb67a3326ba950b7a2dac6fdb4e85
-  data.tar.gz: fd3af2dd9e9f676e44d039307010875c80502c6a27ec12f27cefd211ba098b72f5e8d8a4aafc0d971cdf4ab682511801bcb65e5ef0c3c69f7738865ad2e4c1f4
+  metadata.gz: 5a91c3147ae3ff54bb5b9e1fbe55567ed0394a1d58263be05a3e252c691db429797dae9f2ed2265968d6e2ccbc17f34d63ce5e694f234d1f07b9de3a21ed3896
+  data.tar.gz: 1cade03851a761b7122a6f0e04532870b17ccea87e8e2d46315c3e761566b8495bf4c94b6434b71356026884c7e5fa4ea6ba0e5b93958fcaa557f0d9540c3ddb

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/PredicateName:
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Style/SignalException:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingComma:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+env:
+  global:
+    secure: MqBEEAkWJkzm/hrmI+BTH1cL00jiswMWOl3QAiRfyGwG+Qj3cogYUz1jEKW7olhgAFTXc8SIooSjfp53yXWRlN1bXkkfPPNoyiyeFa7n62wCgaaQ435NpXBuf3YJwZTkbcCGYogOLSdOkuTtYJJ5IBp0naMm/CGHttvP8H6gj8A=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.2
+- Support slop version 4
+
 ## 0.1.1
 - Support Knowledge Q&A API (Thx @kkosuge)
 

data/Gemfile

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

data/README.md

@@ -1,15 +1,37 @@
-# Docomoru
+# Docomoru [![Build Status](https://travis-ci.org/r7kamura/docomoru.svg)](https://travis-ci.org/r7kamura/docomoru) [![Code Climate](https://codeclimate.com/github/r7kamura/docomoru/badges/gpa.svg)](https://codeclimate.com/github/r7kamura/docomoru) [![Test Coverage](https://codeclimate.com/github/r7kamura/docomoru/badges/coverage.svg)](https://codeclimate.com/github/r7kamura/docomoru)
 Client library for docomo API written in Ruby.
 
 ## Install
-Note: requires Ruby 2.0.0 or higher.
+docomoru can be installed from [rubygems.org](https://rubygems.org/gems/docomoru) as a gem.
 
 ```sh
 gem install docomoru
 ```
 
-## Library
-Currenty Docomoru is supporting [Dialogue API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=3) & [Knowledge Q&A API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=6).
+## Authentication
+To use docomo API via docomoru, you need to get docomo API Key.
+
+1. Sign-in to https://dev.smt.docomo.ne.jp/
+2. Register new application
+3. Generate API Key
+
+## Supported APIs
+Currently docomoru is supporting the following APIs.
+
+- [Dialogue API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=3)
+- [Knowledge Q&A API](https://dev.smt.docomo.ne.jp/?p=docs.api.page&api_docs_id=6).
+
+## Usage
+You can use docomoru as a library on Ruby code or an executable on CLI.
+
+### Library
+Create an instance of `Docomoru::Client`,
+then call a method to send an HTTP request to docomo API.
+Each method returns `Docomoru::Response` that has status code, headers, and body values.
+
+Here is an example code to use Dialogue API via docomoru.
+As you can see, `Docomoru::Client` provides low-level interface of HTTP,
+so you may need some wrapper class to use it from your application.
 
 ```rb
 client = Docomoru::Client.new(api_key: ENV["DOCOMO_API_KEY"])
@@ -32,7 +54,9 @@ response.body #=> {
 ```
 
 ## CLI
-`docomoru` executable is bundled to call use Docomoru from CLI.
+`docomoru` executable is bundled to call docomo API from CLI.
+This executable handily creates an instance of `Docomoru::Client` with given API Key,
+then call the specified method, and returns its response.
 
 ```
 $ docomoru <method> <arguments> [options]

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:style)
+task default: [:style, :spec]

data/docomoru.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack"
   spec.add_dependency "slop"
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "codeclimate-test-reporter", "0.4.4"
+  spec.add_development_dependency "rake", "10.4.2"
+  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency "rubocop", "0.29.1"
+  spec.add_development_dependency "webmock", "1.20.4"
 end

data/lib/docomoru/arguments.rb

@@ -24,7 +24,7 @@ module Docomoru
     end
 
     def method_name
-      ARGV[0]
+      slop_options.arguments[0]
     end
 
     def params
@@ -70,7 +70,7 @@ module Docomoru
     end
 
     def has_valid_arguments?
-      -(Client.instance_method(method_name).arity) - 1 == arguments.length
+      -(Client.instance_method(method_name).arity) == arguments.length
     end
 
     def has_valid_method_name?
@@ -98,7 +98,7 @@ module Docomoru
         params = {}
         headers = {}
         arguments = []
-        ARGV[1..-1].each do |section|
+        slop_options.arguments[1..-1].each do |section|
           case
           when /(?<key>.+):(?<value>[^=]+)/ =~ section
             headers[key] = value
@@ -119,12 +119,16 @@ module Docomoru
     end
 
     def slop_options
-      @slop_options ||= Slop.parse!(@argv) do
-        banner "Usage: docomoru <method> [arguments] [headers|params] [options]"
-        on "a", "api-key=", "Pass API Key or use DOCOMO_API_KEY instead"
-        on "h", "help", "Display help message"
-        on "header", "Show response header"
-        on "no-body", "Hide response body"
+      @slop_options ||= Slop.parse(@argv, suppress_errors: true) do |options|
+        options.banner = "Usage: docomoru <method> [arguments] [headers|params] [options]"
+        if Slop::VERSION >= "4.0.0"
+          options.string("-a", "--api-key", "Pass API Key or use DOCOMO_API_KEY instead")
+        else
+          options.on("-a", "--api-key=", "Pass API Key or use DOCOMO_API_KEY instead")
+        end
+        options.on("-h", "--help", "Display help message")
+        options.on("--header", "Show response header")
+        options.on("--no-body", "Hide response body")
       end
     end
   end

data/lib/docomoru/client.rb

@@ -5,7 +5,6 @@ require "docomoru/version"
 require "active_support/core_ext/object/to_query"
 require "faraday"
 require "faraday_middleware"
-require "uri"
 
 module Docomoru
   class Client
@@ -20,7 +19,7 @@ module Docomoru
     include DialogueMethods
     include KnowledgeMethods
 
-    # @param [String] api_key APIKEY issued from DoCoMo.
+    # @param [String] api_key API Key issued from docomo.
     def initialize(api_key: nil)
       @api_key = api_key
     end
@@ -55,7 +54,7 @@ module Docomoru
       Response.new(
         connection.send(
           request_method,
-          URI.escape(path),
+          path,
           params,
           headers,
         )

data/lib/docomoru/dialogue_methods.rb

@@ -2,10 +2,10 @@ module Docomoru
   module DialogueMethods
     PATH = "/dialogue/v1/dialogue"
 
-    def create_dialogue(utt, params = {}, headers = {})
+    def create_dialogue(message, params = {}, headers = {})
       post(
         "#{PATH}?#{default_query_string}",
-        params.merge(utt: utt),
+        params.merge(utt: message),
         headers,
       )
     end

data/lib/docomoru/knowledge_methods.rb

@@ -2,9 +2,9 @@ module Docomoru
   module KnowledgeMethods
     PATH = "/knowledgeQA/v1/ask"
 
-    def create_knowledge(q, params = {}, headers = {})
+    def create_knowledge(message, params = {}, headers = {})
       get(
-        "#{PATH}?#{default_query_string}&q=#{q}",
+        "#{PATH}?#{default_query_string}&q=#{message}",
         params,
         headers,
       )

data/lib/docomoru/version.rb

@@ -1,3 +1,3 @@
 module Docomoru
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/docomoru/client_spec.rb

@@ -0,0 +1,64 @@
+require "active_support/core_ext/object/to_query"
+
+RSpec.describe Docomoru::Client do
+  let(:client) do
+    described_class.new(api_key: api_key)
+  end
+
+  let(:api_key) do
+    "dummy"
+  end
+
+  describe "#create_dialogue" do
+    subject do
+      client.create_dialogue(message)
+    end
+
+    let(:message) do
+      "test"
+    end
+
+    let!(:stubbed_request) do
+      stub_request(
+        :post,
+        "https://api.apigw.smt.docomo.ne.jp/dialogue/v1/dialogue?" + {
+          APIKEY: api_key,
+        }.to_query,
+      ).with(
+        body: {
+          utt: message,
+        },
+      )
+    end
+
+    it "sends HTTP request with given message and API key to Dialogue API" do
+      is_expected.to be_a Docomoru::Response
+      expect(stubbed_request).to have_been_requested
+    end
+  end
+
+  describe "#create_knowledge" do
+    subject do
+      client.create_knowledge(message)
+    end
+
+    let(:message) do
+      "test"
+    end
+
+    let!(:stubbed_request) do
+      stub_request(
+        :get,
+        "https://api.apigw.smt.docomo.ne.jp/knowledgeQA/v1/ask?" + {
+          APIKEY: api_key,
+          q: message,
+        }.to_query,
+      )
+    end
+
+    it "sends HTTP request with given message and API key to Knowledge API" do
+      is_expected.to be_a Docomoru::Response
+      expect(stubbed_request).to have_been_requested
+    end
+  end
+end

data/spec/docomoru/command_builder_spec.rb

@@ -0,0 +1,59 @@
+RSpec.describe Docomoru::CommandBuilder do
+  let(:argv) do
+    []
+  end
+
+  let(:command_builder) do
+    described_class.new(argv)
+  end
+
+  describe "#build" do
+    subject do
+      command_builder.call.call
+    end
+
+    let(:dummy_response) do
+      double(
+        body: {},
+        headers: {},
+        status: 200,
+        status_message: "OK",
+      )
+    end
+
+    context "with unknown command line option" do
+      let(:argv) do
+        super() << "--unknown"
+      end
+
+      it "aborts with help message" do
+        expect_any_instance_of(Docomoru::Commands::Error).to receive(:abort)
+        subject
+      end
+    end
+
+    context "with create_dialogue" do
+      let(:argv) do
+        super() + %w[create_dialogue message --api-key dummy]
+      end
+
+      it "calls create_dialogue method" do
+        expect_any_instance_of(Docomoru::Commands::Request).to receive(:print)
+        expect_any_instance_of(Docomoru::Client).to receive(:create_dialogue).and_return(dummy_response)
+        subject
+      end
+    end
+
+    context "with create_knowledge" do
+      let(:argv) do
+        super() + %w[create_knowledge message --api-key dummy]
+      end
+
+      it "calls create_knowledge method" do
+        expect_any_instance_of(Docomoru::Commands::Request).to receive(:print)
+        expect_any_instance_of(Docomoru::Client).to receive(:create_knowledge).and_return(dummy_response)
+        subject
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+if ENV["CI"]
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require "docomoru"
+require "webmock/rspec"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.warnings = true
+
+  config.after(:suite) do
+    WebMock.disable_net_connect!(allow: "codeclimate.com")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docomoru
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -109,33 +109,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.29.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 1.20.4
 description: 
 email:
 - r7kamura@gmail.com
@@ -145,6 +187,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -165,6 +210,9 @@ files:
 - lib/docomoru/response.rb
 - lib/docomoru/response_renderer.rb
 - lib/docomoru/version.rb
+- spec/docomoru/client_spec.rb
+- spec/docomoru/command_builder_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/r7kamura/docomoru
 licenses:
 - MIT
@@ -185,9 +233,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Client library for docomo API written in Ruby.
-test_files: []
+test_files:
+- spec/docomoru/client_spec.rb
+- spec/docomoru/command_builder_spec.rb
+- spec/spec_helper.rb
 has_rdoc: