esa 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7d9b5d5c382feb73b6bf8a6714ec15816f74e7f
-  data.tar.gz: b3c920162debb1f6941ff0c1f8fec30493f72d96
+  metadata.gz: bedc15159efe6b571a0df4753902fe487ff8d8e1
+  data.tar.gz: 1188815dc7d971b4819c9fc9f396c12d71f5f913
 SHA512:
-  metadata.gz: 173798517bd60ee374cb07ff14b03a3be83b9df9a70f97f603343e12d881d8b1afe17b591452235fcec527adf8f4b8fb896a69d5140cc45ebe506ed0f789eac2
-  data.tar.gz: 8ea9093782efbdd0c3242d7638558d3fd8631c0c29dfe3eb6eeedacec369c84dd2c6963cc2b9041b31faab279c7840927b284b4eb26a7156a692cb567f83ec64
+  metadata.gz: 31aa9d801d5c975caee64580564b57dee14d6c72a1be07772f03abb627cccef2ba1d12227adb3f5cea5aae1adec3fa24e25b26b62e6696f0b3583e72f9a081bb
+  data.tar.gz: 96d3cc780482de6b84f4df04c7870b7f593d21546aaa2a0461690c0773894141326cbc7128e4d5d9cd82ac8249c0f02fb80d0c3f91988543d74d0197916babc5

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format=progress --format=Nc

data/Guardfile

@@ -0,0 +1,17 @@
+# More info at https://github.com/guard/guard#readme
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/README.md

@@ -1,6 +1,6 @@
-# Esa
+# esa-ruby
 
-( ⁰⊖⁰): Write a gem description
+[WIP] esa API v2 client library, written in Ruby
 
 ## Installation
 
@@ -20,11 +20,31 @@ Or install it yourself as:
 
 ## Usage
 
-( ⁰⊖⁰): Write usage instructions here
+```ruby
+client = Esa::Client.new(access_token: "<access_token>", current_team: 'foo')
+client.teams
+#=> GET /v1/teams
+
+client.team('bar')
+#=> GET /v1/teams/bar
+
+client.posts
+#=> GET /v1/teams/foo/posts
+
+client.current_team = 'foobar'
+client.post(1)
+#=> GET /v1/teams/foobar/posts/1
+
+client.update_post(1, name: 'baz')
+#=> PATCH /v1/teams/foobar/posts/1
+
+client.delete_post(1)
+#=> DELETE /v1/teams/foobar/posts/1
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/esa/fork )
+1. Fork it ( https://github.com/esaio/esa-ruby/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`)

data/Rakefile

@@ -1,2 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new("spec")
+task default: :spec

data/esa.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Esa::VERSION
   spec.authors       = ["fukayatsu"]
   spec.email         = ["fukayatsu@gmail.com"]
-  spec.summary       = %q{( ⁰⊖⁰): Write a short summary. Required.}
-  spec.description   = %q{( ⁰⊖⁰): Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.summary       = %q{[WIP] esa API v2 client library, written in Ruby}
+  spec.description   = %q{([WIP] esa API v2 client library, written in Ruby}
+  spec.homepage      = "https://github.com/esaio/esa-ruby/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,6 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "faraday", "~> 0.9"
+  spec.add_runtime_dependency "faraday_middleware"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rspec-nc"
 end

data/lib/esa.rb

@@ -1,5 +1,5 @@
-require "esa/version"
+require "faraday"
+require "faraday_middleware"
 
-module Esa
-  # Your code goes here...
-end
+require "esa/version"
+require "esa/client"

data/lib/esa/api_methods.rb

@@ -0,0 +1,40 @@
+module Esa
+  module ApiMethods
+    def teams(params = nil, headers = nil)
+      send_get("/v1/teams", params, headers)
+    end
+
+    def team(name, params = nil, headers = nil)
+      send_get("/v1/teams/#{name}", params, headers)
+    end
+
+    def posts(params = nil, headers = nil)
+      send_get("/v1/teams/#{current_team}/posts", params, headers)
+    end
+
+    def post(number, params = nil, headers = nil)
+      send_get("/v1/teams/#{current_team}/posts/#{number}", params, headers)
+    end
+
+    def create_post(params = nil, headers = nil)
+      send_post("/v1/teams/#{current_team}/posts", wrap(params, :post), headers)
+    end
+
+    def update_post(number, params = nil, headers = nil)
+      send_patch("/v1/teams/#{current_team}/posts/#{number}", wrap(params, :post), headers)
+    end
+
+    def delete_post(number, params = nil, headers = nil)
+      send_delete("/v1/teams/#{current_team}/posts/#{number}", params, headers)
+    end
+
+    private
+
+    def wrap(params, envelope)
+      return params if params.nil?
+      return params unless params.is_a?(Hash)
+      return params if params.has_key?(envelope.to_sym) || params.has_key?(envelope.to_s)
+      { envelope => params }
+    end
+  end
+end

data/lib/esa/client.rb

@@ -0,0 +1,83 @@
+require 'esa/api_methods'
+require "esa/response"
+require 'esa/errors'
+
+module Esa
+  class Client
+    include ApiMethods
+
+    def initialize(access_token: nil, api_endpoint: nil, current_team: nil)
+      @access_token = access_token
+      @api_endpoint = api_endpoint
+      @current_team = current_team
+    end
+    attr_writer :current_team
+
+    def current_team
+      raise TeamNotSpecifiedError, "current_team is not specified" unless @current_team
+      @current_team
+    end
+
+    def send_get(path, params = nil, headers = nil)
+      send_request(:get, path, params, headers)
+    end
+
+    def send_post(path, params = nil, headers = nil)
+      send_request(:post, path, params, headers)
+    end
+
+    def send_put(path, params = nil, headers = nil)
+      send_request(:put, path, params, headers)
+    end
+
+    def send_patch(path, params = nil, headers = nil)
+      send_request(:patch, path, params, headers)
+    end
+
+    def send_delete(path, params = nil, headers = nil)
+      send_request(:delete, path, params, headers)
+    end
+
+    def send_request(method, path, params, headers)
+      Esa::Response.new(connection.send(method, path, params, headers))
+    end
+
+    def connection
+      @connection ||= Faraday.new(faraday_options) do |c|
+        c.request  :json
+        c.response :json
+        c.adapter  Faraday.default_adapter
+      end
+    end
+
+    private
+
+    def faraday_options
+      {
+        url:     faraday_url,
+        headers: faraday_headers,
+        # ssl:     { verify: !!faraday_url.match(/^https:\/\//) },
+      }
+    end
+
+    def default_headers
+      {
+        'Accept'       => 'application/json',
+        'User-Agent'   => "Esa Ruby Gem #{Esa::VERSION}",
+      }
+    end
+
+    def faraday_headers
+      return default_headers unless access_token
+      default_headers.merge(Authorization: "Bearer #{access_token}")
+    end
+
+    def access_token
+      @access_token || ENV['ESA_ACCESS_TOKEN']
+    end
+
+    def faraday_url
+      @api_endpoint || ENV["ESA_API_ENDPOINT"] || "https://api.esa.io"
+    end
+  end
+end

data/lib/esa/errors.rb

@@ -0,0 +1,4 @@
+module Esa
+  class EsaError < StandardError; end
+  class TeamNotSpecifiedError < EsaError; end
+end

data/lib/esa/response.rb

@@ -0,0 +1,23 @@
+module Esa
+  class Response
+    def initialize(faraday_response)
+      @raw_body    = faraday_response.body
+      @raw_headers = faraday_response.headers
+      @raw_status  = faraday_response.status
+    end
+
+    def body
+      @raw_body
+    end
+
+    def headers
+      @headers ||= @raw_headers.headers.inject({}) do |result, (key, value)|
+        result.merge(key.split("-").map(&:capitalize).join("-") => value)
+      end
+    end
+
+    def status
+      @raw_status
+    end
+  end
+end

data/lib/esa/version.rb

@@ -1,3 +1,3 @@
 module Esa
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/esa/client_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+
+RSpec.describe Esa::Client do
+  let(:access_token) { nil }
+  let(:api_endpoint) { nil }
+  let(:current_team) { nil }
+  let(:options) do
+    {
+      access_token: access_token,
+      api_endpoint: api_endpoint,
+      current_team: current_team,
+    }
+  end
+  subject(:client) { described_class.new(options) }
+
+  describe "#current_team" do
+    context 'team not specified' do
+      it 'raise error' do
+        expect do
+          client.current_team
+        end.to raise_error Esa::TeamNotSpecifiedError
+      end
+    end
+
+    context 'team specified' do
+      let(:current_team) { '<team>' }
+      it 'return current_team' do
+        expect(client.current_team).to eq current_team
+      end
+    end
+  end
+
+  %i(get post put patch delete).each do |method|
+    describe "#send_#{method}" do
+      let(:path)    { '<path>' }
+      let(:params)  { '<params>' }
+      let(:headers) { '<headers>' }
+      it "call send_request with method, path, params and headers" do
+        expect(client).to receive(:send_request).with(method, path, params, headers)
+        client.__send__("send_#{method}", path, params, headers)
+      end
+    end
+  end
+
+  # describe "#send_request", :vcr do
+  #   it 'returns Esa::Response' do
+  #     expect(client.teams).to be_a Esa::Response
+  #   end
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'esa'
+require 'webmock/rspec'
+require 'vcr'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.filter_sensitive_data('<ACCESS_TOKEN>') { ENV['ESA_ACCESS_TOKEN'] }
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: esa
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - fukayatsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-22 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +66,105 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: "( ⁰⊖⁰): Write a longer description. Optional."
+- !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: rspec
+  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: webmock
+  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: vcr
+  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: guard
+  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: guard-rspec
+  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-nc
+  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: "([WIP] esa API v2 client library, written in Ruby"
 email:
 - fukayatsu@gmail.com
 executables: []
@@ -46,14 +172,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - esa.gemspec
 - lib/esa.rb
+- lib/esa/api_methods.rb
+- lib/esa/client.rb
+- lib/esa/errors.rb
+- lib/esa/response.rb
 - lib/esa/version.rb
-homepage: ''
+- spec/esa/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/esaio/esa-ruby/
 licenses:
 - MIT
 metadata: {}
@@ -76,6 +210,8 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: "( ⁰⊖⁰): Write a short summary. Required."
-test_files: []
+summary: "[WIP] esa API v2 client library, written in Ruby"
+test_files:
+- spec/esa/client_spec.rb
+- spec/spec_helper.rb
 has_rdoc: