esa 1.18.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30bd891e4b419207197f4357cbcebc7ba4c5be8237e6fb9a0d2597535a6e01d2
-  data.tar.gz: 2b43e6798a52f317aa7cda989c7955ed1a06047e20c63b351a2a7b86efe36d21
+  metadata.gz: eea23711a36940309cbb971274c7fc6d284cf283da6eec30c9cff011fb75718f
+  data.tar.gz: 91db4cae26f412274440fa0f049cb0df75d4486a1b081668fd231d322ee22c7a
 SHA512:
-  metadata.gz: d7dd2bac6331746966470399273015996a91ef5c2662c65ae0c9474a969dc27e6ae8c4c4d11cc0e40c9e1a59c4c3636abc49432a8787d475eb885cb880c67baa
-  data.tar.gz: 4a8989aca4bdef1de8b64b24853096c50dab38f2240adddde800071d211f60d79fdc48c038811c60a97d4cf892a1474d29b20faa55557de2f04e91df0cd376a0
+  metadata.gz: 9790b5833e9c5f6cf2a31b89264a3b5db33b5f03c8c96e7cf253923cb2dd61572453009a470e5bfe4641cca4013b0e0285fff1113eb8821d7cc4461a010741cd
+  data.tar.gz: 658a076b4b69d6694bb62f5f2d02c3ecba0ad7e7e9b656800b38550c319ac701446d11877021f0c599e54fb08956bf38926a2308ad5aa6c6f3c2e52cfec02f33

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 ## Unreleased
 
 nothing
+## 2.1.0 (2023-10-03)
+
+- add: [Support GET /v1/%{team_name}/members/%{identifier} API by ppworks · Pull Request #63 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/63)
+- doc: [Update "DELETE /v1/teams/bar/members/" section in the README](https://github.com/esaio/esa-ruby/pull/62)
+- ci: [Bump actions/checkout from 3 to 4](https://github.com/esaio/esa-ruby/pull/61)
+- ci: [Add github-actions to Dependabot](https://github.com/esaio/esa-ruby/pull/60)
+
+## 2.0.0 (2023-04-06)
+
+- :warning: breaking: [Support Faraday 2.0.1+ by fukayatsu · Pull Request #58 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/58)
+  - Drop support for Ruby < 2.7.0
+  - Drop support for Faraday < 2.0.1
 
 ## 1.18.0 (2020-10-19)
 
@@ -13,74 +25,96 @@ nothing
 - **changed**: Drop support for Ruby 2.4
 
 ## 1.16.0 (2020-01-20)
+
 - add: [Enable to set default_headers by fukayatsu · Pull Request #43 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/43)
 
 ## 1.15.0 (2019-12-27)
+
 - add: [Add ApiMethods#delete_member by fukayatsu · Pull Request #40 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/40)
 - ci: [Use github actions for CI by fukayatsu · Pull Request #38 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/38)
 - ci: [Update development environment by fukayatsu · Pull Request #37 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/37)
 
 ## 1.14.0 (2018-12-13)
+
 - changed: [Relax gem dependencies by ppworks · Pull Request #35 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/35)
 
 ## 1.13.0 (2017-11-01)
+
 - **changed**: [Retry on rate limit exceeded by default by fukayatsu · Pull Request #31 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/31)
   - Use `Esa::Client.new(retry_on_rate_limit_exceeded: false, ...)` for previous behavior.
 - doc: [Fixed README typo by polidog · Pull Request #30 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/30)
 
 ## 1.12.0 (2017-10-03)
+
 - add: [Support /api/v1/comments API by ppworks · Pull Request #29 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/29)
 
 ## 1.11.0 (2017-09-04)
+
 - add: [Support emoji API by ppworks · Pull Request #28 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/28)
 
 ## 1.10.0 (2017-08-22)
+
 - add: [Support invitation API by ppworks · Pull Request #27 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/27)
 
 ## 1.9.0 (2017-08-02)
+
 - add: [Enable to set headers for remote url on #upload_attachment by nownabe · Pull Request #26 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/26)
 
 ## 1.8.0 (2017-02-25)
+
 - add: [Add batch_move_category API by fukayatsu · Pull Request #25 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/25)
 
 ## 1.7.0 (2016-08-16)
+
 - add: [Support signed_url API by fukayatsu · Pull Request #24 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/24)
 - fix: [Fix a typo by ksss · Pull Request #23 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/23)
 
 ## 1.6.0 (2016-06-10)
+
 - add: [Add Categories API and Tags API by fukayatsu · Pull Request #22 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/22)
 
 ## 1.5.0 (2016-05-05)
+
 - add: [Add Reaction APIs: star&watch by fukayatsu · Pull Request #20 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/20)
 
 ## 1.4.0 (2016-04-17)
+
 - add: [Add Authenticated User API by fukayatsu · Pull Request #19 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/19)
 
 ## 1.3.0 (2016-02-09)
+
 - add: [Add Sharing API by fukayatsu · Pull Request #17 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/17)
 
 ## 1.2.0 (2015-12-03)
+
 - add: [Add Members API by fukayatsu · Pull Request #16 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/16)
 
 ## 1.1.2 (2015-10-05)
+
 - fix: [Esa::Client#upload_attachment needs 'multi_xml' gem by ppworks · Pull Request #15 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/15)
 
 ## 1.1.1 (2015-10-01)
+
 - add: [Enable to set cookie for remote url on #upload_attachment by fukayatsu · Pull Request #14 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/14)
 
 ## 1.1.0 (2015-10-01)
+
 - add: [Enable to Upload Attachment by fukayatsu · Pull Request #13 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/13)
 
 ## 1.0.0 (2015-09-25)
+
 - Production Ready (\\( ⁰⊖⁰)/)
 - [Add Stats API by fukayatsu · Pull Request #12 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/12)
 - [Use Travis CI for testing by hanachin · Pull Request #11 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/11)
 
 ## 0.0.6 (2015-06-21)
+
 - [Support Comment API by fukayatsu · Pull Request #9 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/9)
 
 ## 0.0.5 (2015-05-21)
+
 - [Use current_team! instead of current_team by fukayatsu · Pull Request #8 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/8)
 
 ## 0.0.4 (2015-05-14)
+
 - [Fix Esa::Response#headers and implement its spec by yasaichi · Pull Request #7 · esaio/esa-ruby](https://github.com/esaio/esa-ruby/pull/7)

data/README.md

@@ -43,10 +43,25 @@ client.stats
 client.members
 #=> GET /v1/teams/bar/members
 
-screen_name = 'alice'
-client.delete_member(screen_name)
+client.member('me')
+#=> GET /v1/teams/bar/members/me
+
+find_by_screen_name = 'alice'
+client.member(find_by_screen_name)
+#=> GET /v1/teams/bar/members/alice
+
+find_by_email_address = 'alice@example.com'
+client.member(find_by_email_address)
+#=> GET /v1/teams/bar/members/alice@example.com
+
+delete_by_screen_name = 'alice'
+client.delete_member(delete_by_screen_name)
 #=> DELETE /v1/teams/bar/members/alice
 
+delete_by_email_address = 'alice@example.com'
+client.delete_member(delete_by_email_address)
+#=> DELETE /v1/teams/bar/members/alice@example.com
+
 # Post API
 client.posts
 #=> GET /v1/teams/foo/posts

data/esa.gemspec

@@ -13,13 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/esaio/esa-ruby/'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match?(%r{^(spec/|\.)}) }
   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_runtime_dependency 'faraday', '>= 0.9', '< 2.0'
-  spec.add_runtime_dependency 'faraday_middleware', '>= 0.12', '< 2.0'
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_runtime_dependency 'faraday', '>= 2.0.1', '< 3.0'
+  spec.add_runtime_dependency 'faraday-multipart'
+  spec.add_runtime_dependency 'faraday-xml'
   spec.add_runtime_dependency 'mime-types', '>= 2.6', '< 4.0'
   spec.add_runtime_dependency 'multi_xml', '>= 0.5.5', '< 1.0'
 

data/lib/esa/api_methods.rb

@@ -1,4 +1,6 @@
 require 'base64'
+require 'mime/types'
+
 module Esa
   module ApiMethods
     HTTP_REGEX = %r{^https?://}
@@ -23,6 +25,10 @@ module Esa
       send_get("/v1/teams/#{current_team!}/members", params, headers)
     end
 
+    def member(identifier, params = nil, headers = nil)
+      send_get("/v1/teams/#{current_team!}/members/#{identifier}", params, headers)
+    end
+
     def delete_member(screen_name, params = nil, headers = nil)
       send_delete("/v1/teams/#{current_team!}/members/#{screen_name}", params, headers)
     end
@@ -183,7 +189,7 @@ module Esa
       return response unless response.status == 200
 
       attachment = response.body['attachment']
-      form_data  = response.body['form'].merge(file: Faraday::UploadIO.new(file, params[:type]))
+      form_data  = response.body['form'].merge(file: Faraday::FilePart.new(file, params[:type]))
 
       s3_response = send_s3_request(:post, attachment['endpoint'], form_data)
       return s3_response unless s3_response.status == 204
@@ -206,7 +212,6 @@ module Esa
     end
 
     def content_type_from_file(file)
-      require 'mime/types'
       if mime_type = MIME::Types.type_for(file.path).first
         mime_type.content_type
       end

data/lib/esa/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esa
-  VERSION = '1.18.0'
+  VERSION = '2.1.0'
 end

data/lib/esa.rb

@@ -1,5 +1,6 @@
 require "faraday"
-require "faraday_middleware"
+require "faraday/multipart"
+require "faraday/xml"
 
 require "esa/version"
 require "esa/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esa
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 2.1.0
 platform: ruby
 authors:
 - fukayatsu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,40 +16,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 2.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -160,16 +168,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.6
-description: 
+description:
 email:
 - fukayatsu@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/build.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -182,14 +187,11 @@ files:
 - lib/esa/errors.rb
 - lib/esa/response.rb
 - lib/esa/version.rb
-- spec/esa/client_spec.rb
-- spec/esa/response_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/esaio/esa-ruby/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -197,18 +199,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: esa API v1 client library, written in Ruby
-test_files:
-- spec/esa/client_spec.rb
-- spec/esa/response_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/workflows/build.yml

@@ -1,26 +0,0 @@
-name: build
-
-on: [push]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby:
-        # https://hub.docker.com/_/ruby
-        - '2.5'
-        - '2.6'
-        - '2.7'
-        - 'latest'
-    container:
-      image: ruby:${{ matrix.ruby }}
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
-        bundle exec rake

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.rspec

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

data/spec/esa/client_spec.rb

@@ -1,104 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Esa::Client do
-  let(:access_token) { nil }
-  let(:api_endpoint) { nil }
-  let(:current_team) { nil }
-  let(:default_headers) { {} }
-  let(:options) do
-    {
-      access_token: access_token,
-      api_endpoint: api_endpoint,
-      current_team: current_team,
-      default_headers: default_headers
-    }
-  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 'default_headers' do
-    before do
-      stub_request(:any, 'https://api.esa.io/v1/teams')
-        .to_return do |request|
-          {
-            body: request.body,
-            headers: request.headers
-          }
-        end
-    end
-
-    context 'no default_headers option' do
-      it 'request with basic headers' do
-        response = client.teams
-        expect(response.headers).to eq(
-          'Accept' => 'application/json',
-          'User-Agent' => "Esa Ruby Gem #{Esa::VERSION}",
-          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3'
-        )
-      end
-
-      it 'request with basic headers and additional headers ' do
-        response = client.teams(nil, { 'X-Foo' => 'bar' })
-        expect(response.headers).to eq(
-          'Accept' => 'application/json',
-          'User-Agent' => "Esa Ruby Gem #{Esa::VERSION}",
-          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'X-Foo' => 'bar'
-        )
-      end
-    end
-
-    context 'with default_headers option' do
-      let(:default_headers) { { 'X-Default-Foo' => 'Bar' } }
-
-      it 'request with basic headers and default_headers' do
-        response = client.teams
-        expect(response.headers).to eq(
-          'Accept' => 'application/json',
-          'User-Agent' => "Esa Ruby Gem #{Esa::VERSION}",
-          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'X-Default-Foo' => 'Bar'
-        )
-      end
-
-      it 'request with basic headers and additional headers ' do
-        response = client.teams(nil, { 'X-Foo' => 'baz', 'X-Default-Foo' => 'qux' })
-        expect(response.headers).to eq(
-          'Accept' => 'application/json',
-          'User-Agent' => "Esa Ruby Gem #{Esa::VERSION}",
-          'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'X-Default-Foo' => 'qux',
-          'X-Foo' => 'baz'
-        )
-      end
-    end
-  end
-end

data/spec/esa/response_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Esa::Response do
-  let(:response_status) { 401 }
-  let(:response_body) { '{"error":"unauthorized", "message":"Unauthorized"}' }
-  let(:response_headers) do
-    {
-      'server' => 'Cowboy',
-      'content-type' => 'application/json; charset=utf-8',
-    }
-  end
-  let(:connection) do
-    Faraday.new do |c|
-      c.adapter :test, Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('/test') { [response_status, response_headers, response_body] }
-      end
-    end
-  end
-  let(:response) { described_class.new(connection.get('/test')) }
-
-  describe '#body' do
-    subject { response.body }
-    it { is_expected.to eq response_body }
-  end
-
-  describe '#headers' do
-    subject { response.headers }
-    let(:expectation) do
-      {
-        'Server' => 'Cowboy',
-        'Content-Type' => 'application/json; charset=utf-8',
-      }
-    end
-
-    it { is_expected.to eq expectation }
-  end
-
-  describe '#status' do
-    subject { response.status }
-    it { is_expected.to eq response_status }
-  end
-end

data/spec/spec_helper.rb

@@ -1,27 +0,0 @@
-require 'esa'
-require 'webmock/rspec'
-
-# 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