spearly-sdk-ruby 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63b85112898d41d2cfb6f4a65f45e371f5c83cef8ea80402c80f5e2914a32aa
-  data.tar.gz: bf0cda8a4184a7e3bbe29ff067f5b575969c60c67f14737bd3d723de5fe32091
+  metadata.gz: 16d6c0eba9178b85d9b63c138e630b6d7ac9075b4ea5aeb757e2e55851cb1071
+  data.tar.gz: e37743ac296c9e361a61a45d37f8cff1f1f2473d885ee552ad374ee74c65b76e
 SHA512:
-  metadata.gz: 25732ccb37984d326cb936cdbba1c7a11fccbbdf034b52ba96c542c759e0eeedcd47d5e873aeb3be439e02f069e37b8d7ccddc404dbe43759a081d7a7e7f8b78
-  data.tar.gz: 4d42a6e0fb080d2c94eef1d3d827317b0ec292d00f771beeedb132b6cc53105369531d4e5689b40ad218d2e5dc53b3eb066b48644d5e421c544e00db2ccba640
+  metadata.gz: c13568331964dc5761788b1eaace9793d2f1d8a1784dfc87bcd5bae1fe478990406408172cdc2c5950169a23ad52cc3e340872b64a5fc83eb6938e8e1885d371
+  data.tar.gz: 451b44aa43c50ba805fedd69c2d84a64f10877bf682a77d2a2f616a5bbad6800c4a6e327e9cfaab27fe3f3e9c9cfc2d3f6f2e92cb2d7acb30103b73d4c456c2c

data/.github/workflows/main.yml

@@ -1,5 +1,5 @@
 name: Ruby
-on: [push, pull_request]
+on: [push]
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -8,9 +8,9 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.2
+        ruby-version: 2.7.7
     - name: Run the default task
       run: |
-        gem install bundler -v 2.2.15
+        gem install bundler -v 2.3.26
         bundle install
         bundle exec rake

data/.rubocop.yml

@@ -1,4 +1,5 @@
-require: rubocop-rspec
+require:
+  - rubocop-rspec
 AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7
@@ -15,6 +16,8 @@ Metrics/ClassLength:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
+RSpec/BeNil:
+  EnforcedStyle: 'be'
 RSpec/ExampleLength:
   Enabled: false
 RSpec/MessageSpies:

data/CHANGELOG.md

@@ -1,15 +1,19 @@
+## [0.9.0] - 2022-12-05
+
+- Return `errors` object on `Spearly::Auth::Client#create_team()`'s 422 responses
+
 ## [0.8.0] - 2022-06-15
 
-- `Spearly::Auth::Client#get_user`
+- `Spearly::Auth::Client#get_user()`
 
 ## [0.7.0] - 2022-01-31
 
-- `Spearly::Cloud::Client#get_site`
-- `Spearly::Cloud::Client#get_sites`
+- `Spearly::Cloud::Client#get_site()`
+- `Spearly::Cloud::Client#get_sites()`
 
 ## [0.6.0] - 2022-01-20
 
-- `Spearly::Auth::Client#get_team_features`
+- `Spearly::Auth::Client#get_team_features()`
 
 ## [0.5.0] - 2021-12-13
 
@@ -22,7 +26,7 @@
 ## [0.3.2] - 2021-09-13
 
 - Use the new `Spearly API v2`
-- Refactors parsing `JSON` data
+- Refactor parsing `JSON` data
 
 ## [0.2.4] - 2021-07-16
 
@@ -34,10 +38,11 @@
 
 ## [0.2.2] - 2021-06-11
 
-- Updates `README` and gem specs
+- Update `README` and gem specs
 
 ## [0.2.1] - 2021-05-31
 
+
 - Initialize `Spearly::Auth::User` with bearer token
 
 ## [0.2.0] - 2021-05-31

data/Gemfile

@@ -2,3 +2,5 @@
 
 source 'https://rubygems.org'
 gemspec
+
+gem 'rails', '>= 6.0', '< 7.1'

data/lib/spearly/auth/authorizer.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require 'signet/oauth_2/client'
+require 'active_support/core_ext/hash/indifferent_access'
 
 module Spearly
   module Auth
     class Authorizer
       def initialize(params)
-        @params = params
+        @params = params.deep_symbolize_keys
         @client = initialize_client
       end
 
@@ -16,6 +17,10 @@ module Spearly
         raise Spearly::Auth::AuthorizationError
       end
 
+      def respond_to_missing?(_name, *_args)
+        true
+      end
+
       private
 
       def initialize_client
@@ -25,23 +30,21 @@ module Spearly
           }
         }
 
-        client = ::Signet::OAuth2::Client.new
-        client.client_id = @params[:client_id] || @params['client_id']
-        client.client_secret = @params[:client_secret] || @params['client_secret']
-        client.code = @params[:code] || @params['code']
-        client.grant_type = @params[:grant_type] || @params['grant_type']
-        client.authorization_uri = "#{ENV['SPEARLY_API_URL']}/oauth/authorize"
-        client.token_credential_uri = "#{ENV['SPEARLY_API_URL']}/oauth/token"
-        client.redirect_uri = @params[:redirect_uri] || @params['redirect_uri']
-
-        client.access_token = @params[:access_token] || @params['access_token']
-        client.refresh_token = @params[:refresh_token] || @params['refresh_token']
-        client.id_token = @params[:id_token] || @params['id_token']
-        client.expires_in = @params[:expires_in] || @params['expires_in']
-        client.issued_at = @params[:issued_at] || @params['issued_at']
-        client.expires_at = @params[:expires_at] || @params['expires_at']
-
-        client
+        ::Signet::OAuth2::Client.new(
+          client_id: @params[:client_id],
+          client_secret: @params[:client_secret],
+          code: @params[:code],
+          grant_type: @params[:grant_type],
+          authorization_uri: "#{ENV.fetch('SPEARLY_API_URL', nil)}/oauth/authorize",
+          token_credential_uri: "#{ENV.fetch('SPEARLY_API_URL', nil)}/oauth/token",
+          redirect_uri: @params[:redirect_uri],
+          access_token: @params[:access_token],
+          refresh_token: @params[:refresh_token],
+          id_token: @params[:id_token],
+          expires_in: @params[:expires_in],
+          issued_at: @params[:issued_at],
+          expires_at: @params[:expires_at]
+        )
       end
     end
   end

data/lib/spearly/auth/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spearly
   module Auth
     class Client
@@ -6,7 +8,7 @@ module Spearly
       end
 
       def get_user(user_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/users/#{user_id}"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/users/#{user_id}"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -23,7 +25,7 @@ module Spearly
       end
 
       def create_team(params)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -32,15 +34,18 @@ module Spearly
                           'Accept' => 'application/vnd.spearly.v2+json',
                           'Authorization' => @token)
 
-        if res.status == 201
+        case res.status
+        when 201
           JSON.parse(res.body)['data']
+        when 422
+          JSON.parse(res.body)
         else
           {}
         end
       end
 
       def get_team(team_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -57,7 +62,7 @@ module Spearly
       end
 
       def get_teams(params = {})
-        uri = "#{ENV['SPEARLY_API_URL']}/teams"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -74,7 +79,7 @@ module Spearly
       end
 
       def update_team(team_id, params)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -83,15 +88,13 @@ module Spearly
                          'Accept' => 'application/vnd.spearly.v2+json',
                          'Authorization' => @token)
 
-        if res.status == 200
-          JSON.parse(res.body)['data']
-        else
-          nil
-        end
+        return unless res.status == 200
+
+        JSON.parse(res.body)['data']
       end
 
       def regenerate_team_api_access_token(team_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/regenerate_api_access_token"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}/regenerate_api_access_token"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -100,15 +103,13 @@ module Spearly
                           'Accept' => 'application/vnd.spearly.v2+json',
                           'Authorization' => @token)
 
-        if res.status == 200
-          JSON.parse(res.body)['data']
-        else
-          nil
-        end
+        return unless res.status == 200
+
+        JSON.parse(res.body)['data']
       end
 
       def invite_user_to_team(team_id, params)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/invite"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}/invite"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -117,15 +118,13 @@ module Spearly
                           'Accept' => 'application/vnd.spearly.v2+json',
                           'Authorization' => @token)
 
-        if res.status == 201
-          JSON.parse(res.body)['data']
-        else
-          nil
-        end
+        return unless res.status == 201
+
+        JSON.parse(res.body)['data']
       end
 
       def get_team_members(team_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/members"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}/members"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -142,7 +141,7 @@ module Spearly
       end
 
       def get_team_features(team_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/features"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams/#{team_id}/features"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 

data/lib/spearly/auth/oauth_user.rb

@@ -16,6 +16,10 @@ module Spearly
         @data[name.to_s]
       end
 
+      def respond_to_missing?(_name, *_args)
+        true
+      end
+
       def to_json(*_args)
         @data.to_json
       end

data/lib/spearly/auth/team.rb

@@ -13,6 +13,10 @@ module Spearly
         @data[name.to_s]
       end
 
+      def respond_to_missing?(_name, *_args)
+        true
+      end
+
       def to_json(*_args)
         @data.to_json
       end

data/lib/spearly/auth/token.rb

@@ -16,8 +16,12 @@ module Spearly
         @data[name.to_s]
       end
 
+      def respond_to_missing?(_name, *_args)
+        true
+      end
+
       def info
-        token_info_uri = "#{ENV['SPEARLY_API_URL']}/oauth/token/info"
+        token_info_uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/oauth/token/info"
         url = Addressable::URI.parse(token_info_uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -32,7 +36,7 @@ module Spearly
       end
 
       def revoke(params)
-        token_revoke_uri = "#{ENV['SPEARLY_API_URL']}/oauth/revoke"
+        token_revoke_uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/oauth/revoke"
         url = Addressable::URI.parse(token_revoke_uri).normalize.to_s
         client = Faraday.default_connection
 

data/lib/spearly/auth/user.rb

@@ -16,8 +16,12 @@ module Spearly
         @data[name.to_s]
       end
 
+      def respond_to_missing?(_name, *_args)
+        true
+      end
+
       def find
-        user_profile_uri = "#{ENV['SPEARLY_API_URL']}/profile"
+        user_profile_uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/profile"
         url = Addressable::URI.parse(user_profile_uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -32,7 +36,7 @@ module Spearly
       end
 
       def teams
-        teams_uri = "#{ENV['SPEARLY_API_URL']}/teams"
+        teams_uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/teams"
         url = Addressable::URI.parse(teams_uri).normalize.to_s
         client = Faraday.default_connection
 

data/lib/spearly/cloud/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spearly
   module Cloud
     class Client
@@ -6,7 +8,7 @@ module Spearly
       end
 
       def get_sites(params = {})
-        uri = "#{ENV['SPEARLY_API_URL']}/sites"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/sites"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -23,7 +25,7 @@ module Spearly
       end
 
       def get_site(site_id)
-        uri = "#{ENV['SPEARLY_API_URL']}/sites/#{site_id}"
+        uri = "#{ENV.fetch('SPEARLY_API_URL', nil)}/sites/#{site_id}"
         uri_parsed = Addressable::URI.parse(uri).normalize.to_s
         client = Faraday.default_connection
 

data/lib/spearly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spearly
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spearly.gemspec

@@ -10,10 +10,11 @@ Gem::Specification.new do |gem|
 
   gem.summary       = 'Spearly SDK for Ruby'
   gem.homepage      = 'https://github.com/unimal-jp/spearly-sdk-ruby'
-  gem.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
   gem.metadata['homepage_uri'] = gem.homepage
   gem.metadata['source_code_uri'] = 'https://github.com/unimal-jp/spearly-sdk-ruby'
   gem.metadata['changelog_uri'] = "https://github.com/unimal-jp/spearly-sdk-ruby/blob/v#{Spearly::VERSION}/CHANGELOG.md"
+  gem.metadata['rubygems_mfa_required'] = 'true'
 
   gem.files = `git ls-files`.split("\n")
   gem.executables   = 'spearly'
@@ -25,8 +26,10 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'faraday', '>= 0.17.4', '< 2.0'
   gem.add_runtime_dependency 'signet', '~> 0.15'
 
-  gem.add_development_dependency 'pry', '~> 0.13.1'
-  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'bundler-audit', '~> 0.9'
+  gem.add_development_dependency 'fuubar', '~> 2.5'
+  gem.add_development_dependency 'pry', '~> 0.13'
+  gem.add_development_dependency 'rspec', '~> 3.10'
   gem.add_development_dependency 'rubocop', '~> 1.15'
   gem.add_development_dependency 'rubocop-rspec', '~> 2.3'
 end

data/spec/spearly/auth/client_spec.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spearly::Auth::Client do
+  let!(:connection_double) { instance_double(Faraday::Connection) }
+
+  before do
+    stub_const('ENV', { 'SPEARLY_API_URL' => 'https://api.spearly.test' })
+
+    allow(Faraday).to receive(:default_connection).and_return(connection_double)
+  end
+
+  describe '.create_team()' do
+    let!(:response_double) { instance_double(Faraday::Response, status: 201, body: { 'data' => { 'id' => '711' } }.to_json) }
+    let!(:params) { { hey: 'jude' } }
+    let!(:client) { described_class.new('token') }
+
+    before do
+      allow(connection_double).to receive(:post).and_return(response_double)
+    end
+
+    it 'makes POST request to /teams' do
+      uri_parsed = Addressable::URI.parse('https://api.spearly.test/teams').normalize.to_s
+
+      expect(connection_double).to receive(:post).with(uri_parsed,
+                                                       params.as_json,
+                                                       'Accept' => 'application/vnd.spearly.v2+json',
+                                                       'Authorization' => 'token')
+
+      described_class.new('token')
+                     .create_team(params)
+    end
+
+    it 'returns data object if status is 201' do
+      res = client.create_team(params)
+
+      expect(res).to eq('id' => '711')
+    end
+
+    it 'returns errors object if status is 422' do
+      response_double = instance_double(Faraday::Response, status: 422, body: { 'errors' => { 'owner' => ["can't own more than 2 free teams"] } }.to_json)
+
+      allow(connection_double).to receive(:post).and_return(response_double)
+
+      res = client.create_team(params)
+
+      expect(res['errors']).to eq('owner' => ["can't own more than 2 free teams"])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pry'
+require 'rails'
 require 'spearly'
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spearly-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Spearly
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,34 +72,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +189,7 @@ files:
 - lib/spearly/cloud/client.rb
 - lib/spearly/version.rb
 - spearly.gemspec
+- spec/spearly/auth/client_spec.rb
 - spec/spearly_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/unimal-jp/spearly-sdk-ruby
@@ -168,7 +197,8 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/unimal-jp/spearly-sdk-ruby
   source_code_uri: https://github.com/unimal-jp/spearly-sdk-ruby
-  changelog_uri: https://github.com/unimal-jp/spearly-sdk-ruby/blob/v0.8.0/CHANGELOG.md
+  changelog_uri: https://github.com/unimal-jp/spearly-sdk-ruby/blob/v0.9.0/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -177,7 +207,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.2
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="