slice-ruby 0.0.2

data/lib/slice/version.rb

@@ -0,0 +1,3 @@
+module Slice
+  VERSION = "0.0.2"
+end

data/slice-ruby.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "slice/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "slice-ruby"
+  spec.version       = Slice::VERSION
+  spec.authors       = ["Naoki Orii"]
+  spec.email         = ["mrorii@gmail.com"]
+  spec.summary       = "A client library for Slice API written in Ruby."
+  spec.homepage      = "https://github.com/slicedev/slice-ruby"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "faraday", "~> 0.9"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "oauth2"
+  spec.add_dependency "rack"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "rouge"
+  spec.add_dependency "slop", "< 4.0.0"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "json_schema"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "webmock", "1.20.4"
+end

data/spec/slice/client_spec.rb

@@ -0,0 +1,349 @@
+require "spec_helper"
+
+describe Slice::Client do
+  def stub_api_request
+    stub_request(request_method, requested_url).with(
+      body: request_body,
+      headers: requested_headers,
+    ).to_return(
+      body: response_body,
+      headers: response_headers,
+      status: status_code,
+    )
+  end
+
+  let(:status_code) do
+    200
+  end
+
+  let(:response_body) do
+    response_hash.to_json
+  end
+
+  let(:response_hash) do
+    { "dummy" => "dummy" }
+  end
+
+  let(:response_headers) do
+    { "Content-Type" => "application/json" }
+  end
+
+  let(:requested_headers) do
+    Slice::Client::DEFAULT_HEADERS.clone
+  end
+
+  let(:request_body) do
+    params.nil? || [:get, :delete].include?(request_method) ? nil : params
+  end
+
+  let(:requested_url) do
+    "https://#{requested_host}#{path}"
+  end
+
+  let(:requested_host) do
+    Slice::Client::DEFAULT_HOST
+  end
+
+  let(:host) do
+    Slice::Client::DEFAULT_HOST
+  end
+
+  let(:client) do
+    described_class.new(options)
+  end
+
+  let(:options) do
+    {}
+  end
+
+  let(:arguments) do
+    [path, params, headers]
+  end
+
+  let(:path) do
+    "/api/v1/dummy"
+  end
+
+  let(:params) do
+  end
+
+  let(:headers) do
+    {}
+  end
+
+  shared_examples_for "returns a Slice::Response" do
+    it "returns a Slice::Response" do
+      should be_a Slice::Response
+      subject.body.should eq response_hash
+      subject.headers.should eq response_headers
+      subject.status.should eq status_code
+    end
+  end
+
+  shared_examples_for "valid condition" do
+    context "with valid condition" do
+      include_examples "returns a Slice::Response"
+    end
+  end
+
+  shared_examples_for "sends request with JSON-encoded body" do
+    context "with params" do
+      let(:params) do
+        { key1: "value1", key2: "value2" }
+      end
+
+      it "sends request with JSON-encoded body" do
+        should be_a Slice::Response
+      end
+    end
+  end
+
+  shared_examples_for "sends request with URL query" do
+    context "with params" do
+      let(:params) do
+        { key1: "value1", key2: "value2" }
+      end
+
+      let(:requested_url) do
+        super() + "?key1=value1&key2=value2"
+      end
+
+      it "sends request with URL query" do
+        should be_a Slice::Response
+      end
+    end
+  end
+
+  describe ".new" do
+    subject do
+      described_class.new(*arguments)
+    end
+
+    let(:arguments) do
+      [options]
+    end
+
+    let(:options) do
+      {}
+    end
+
+    shared_examples_for "returns a Slice::Client" do
+      it "returns a Slice::Client" do
+        should be_a described_class
+      end
+    end
+
+    context "without any arguments" do
+      let(:arguments) do
+        []
+      end
+      include_examples "returns a Slice::Client"
+    end
+
+    context "with :access_token option" do
+      let(:options) do
+        { access_token: "dummy" }
+      end
+      include_examples "returns a Slice::Client"
+    end
+
+    context "with :host option" do
+      let(:options) do
+        { host: "dummy" }
+      end
+      include_examples "returns a Slice::Client"
+    end
+  end
+
+  describe "#get" do
+    before do
+      stub_api_request
+    end
+
+    subject do
+      client.get(*arguments)
+    end
+
+    let(:request_method) do
+      :get
+    end
+
+    include_examples "valid condition"
+    include_examples "sends request with URL query"
+
+    context "without headers" do
+      let(:arguments) do
+        [path, params]
+      end
+      include_examples "returns a Slice::Response"
+    end
+
+    context "without params nor headers" do
+      let(:arguments) do
+        [path]
+      end
+      include_examples "returns a Slice::Response"
+    end
+
+    context "with a Slice::Client created with :host option" do
+      before do
+        options[:host] = host
+      end
+
+      let(:host) do
+        "example.com"
+      end
+
+      let(:requested_host) do
+        host
+      end
+
+      it "sends request to configured host" do
+        should be_a Slice::Response
+      end
+    end
+
+    context "with a Slice::Client created with :access_token option" do
+      before do
+        options[:access_token] = access_token
+      end
+
+      let(:access_token) do
+        "dummy-access-token"
+      end
+
+      let(:requested_headers) do
+        super().merge("Authorization" => "Bearer #{access_token}")
+      end
+
+      it "sends request with configured access token" do
+        should be_a Slice::Response
+      end
+    end
+
+    context "with headers" do
+      let(:headers) do
+        {
+          "KEY1" => "value1",
+          "KEY2" => "value2",
+        }
+      end
+
+      let(:requested_headers) do
+        super().merge(headers)
+      end
+
+      it "sends request with given headers" do
+        should be_a Slice::Response
+      end
+    end
+
+    context "with params" do
+      let(:params) do
+        { key1: "value1", key2: "value2" }
+      end
+
+      let(:requested_url) do
+        super() + "?key1=value1&key2=value2"
+      end
+
+      it "sends request with URL query, encoded from given params" do
+        should be_a Slice::Response
+      end
+    end
+
+    context "with multibyte path" do
+      let(:path) do
+        ""
+      end
+
+      let(:requested_url) do
+        "https://#{requested_host}#{URI.escape(path)}"
+      end
+
+      it "sends request with escaped path" do
+        should be_a Slice::Response
+      end
+    end
+  end
+
+  describe "#post" do
+    before do
+      stub_api_request
+    end
+
+    subject do
+      client.post(*arguments)
+    end
+
+    let(:request_method) do
+      :post
+    end
+
+    let(:status_code) do
+      201
+    end
+
+    include_examples "valid condition"
+    include_examples "sends request with JSON-encoded body"
+  end
+
+  describe "#patch" do
+    before do
+      stub_api_request
+    end
+
+    subject do
+      client.patch(*arguments)
+    end
+
+    let(:request_method) do
+      :patch
+    end
+
+    include_examples "valid condition"
+    include_examples "sends request with JSON-encoded body"
+  end
+
+  describe "#put" do
+    before do
+      stub_api_request
+    end
+
+    subject do
+      client.put(*arguments)
+    end
+
+    let(:request_method) do
+      :put
+    end
+
+    let(:status_code) do
+      204
+    end
+
+    include_examples "valid condition"
+    include_examples "sends request with JSON-encoded body"
+  end
+
+  describe "#delete" do
+    before do
+      stub_api_request
+    end
+
+    subject do
+      client.delete(*arguments)
+    end
+
+    let(:request_method) do
+      :delete
+    end
+
+    let(:status_code) do
+      204
+    end
+
+    include_examples "valid condition"
+    include_examples "sends request with URL query"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "slice"
+require "webmock/rspec"
+
+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
+end

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: slice-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Naoki Orii
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !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: json_schema
+  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: 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: 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.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.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: 1.20.4
+description: 
+email:
+- mrorii@gmail.com
+executables:
+- slice
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/slice
+- images/cli.png
+- lib/slice.rb
+- lib/slice/arguments.rb
+- lib/slice/client.rb
+- lib/slice/command_builder.rb
+- lib/slice/commands/base.rb
+- lib/slice/commands/error.rb
+- lib/slice/commands/request.rb
+- lib/slice/oauth.rb
+- lib/slice/resource_based_methods.rb
+- lib/slice/response.rb
+- lib/slice/response_renderer.rb
+- lib/slice/version.rb
+- slice-ruby.gemspec
+- spec/slice/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/slicedev/slice-ruby
+licenses: []
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A client library for Slice API written in Ruby.
+test_files:
+- spec/slice/client_spec.rb
+- spec/spec_helper.rb