spearly-sdk-ruby 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90991a87fed739d937f83ef33aa5f18075a3dbe8f2c7d53c53326bf417aa188a
-  data.tar.gz: 02da248080a263211686303a3ba6fce31ed6cb2a3b280e53b1aa3350c94f30da
+  metadata.gz: 13ec9bdf4ea5bf140a8db9a87058c52651fe0631a78f43b1acf116b712270865
+  data.tar.gz: e496438935bfdd23172c8acf06f3c70f2407b362231d15bcd4da6908f7c87d03
 SHA512:
-  metadata.gz: 6023e00a6a9964f2219f0f5776e0b9848b535686c60ac8ec2db4d20dce690a4a7b616109cb8f859ee6c34a8be2f13ec3cc59fa9b2b19fbb8418a302ae2e2f00a
-  data.tar.gz: 9d83e00abdcca65131a8e3af7b7817509fe274373af37bd7c21b7e3db1772c9753b7792836ee2831dc5f8e526316ade8ed8cdfe7b6752d87cdadb3a19af8dd3e
+  metadata.gz: d7cbe36feb66608124b4fb66afc5a7da7564a32af2464cd9bf5ebb3872aca7fe60c23c163bda107479361e4717d3596fee88c506b1160a5e4f0d584421ef0639
+  data.tar.gz: b3a9470ca734f081e49f54f2949a03bfaa52fb4c2a4f35039a2d90f50563e44c17351ec3657146efe47dc3de61ec990fe776df8da0308f21c93d41274955bdfe

data/.gitignore

@@ -1,11 +1,12 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
+.bundle
 .rspec_status
+.ruby-version
+.yardoc
+_yardoc/
+coverage/
+doc/
+Gemfile.local
+Gemfile.lock
+pkg/
+spec/reports/
+tmp/

data/CHANGELOG.md

@@ -1,10 +1,31 @@
+## [0.5.0] - 2021-12-13
+
+- Spearly::Auth::Client
+
+## [0.4.0] - 2021-09-13
+
+- Error handling improvements
+
+## [0.3.2] - 2021-09-13
+
+- Use the new `Spearly API v2`
+- Refactors parsing `JSON` data
+
+## [0.2.4] - 2021-07-16
+
+- Rescue `Signet::AuthorizationError` on `Spearly::Auth::Authorizer`
+
+## [0.2.3] - 2021-06-18
+
+- Raise `Spearly::Auth::AuthorizationError` and `Spearly::Auth::ServerError` from `Spearly::Auth::User` and `Spearly::Auth::Token`
+
 ## [0.2.2] - 2021-06-11
 
-- Updates README and gem specs
+- Updates `README` and gem specs
 
 ## [0.2.1] - 2021-05-31
 
-- Initialize Spearly::Auth::User with bearer token
+- Initialize `Spearly::Auth::User` with bearer token
 
 ## [0.2.0] - 2021-05-31
 

data/README.md

@@ -7,26 +7,55 @@ Spearly SDK for Ruby.
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem 'spearly-sdk-ruby', '~> 0.2.2', require: 'spearly'
+gem 'spearly-sdk-ruby', '~> x.y.z', require: 'spearly'
 ```
 
 And then execute:
 ```sh
-$ bundle install
+bundle install
 ```
 
-Or install it yourself as:
+Or install it manually:
 ```sh
-$ gem install spearly-sdk-ruby
+gem install spearly-sdk-ruby
+```
+
+## Contribute
+### Increment version
+```sh
+vim lib/spearly/version.rb
+```
+
+### Update CHANGELOG
+```sh
+vim CHANGELOG.md
+```
+
+### Update Gemfile.lock
+```sh
+bundle install
+```
+
+### New version commit
+```sh
+new_version=$(ruby -e "require './lib/spearly/version'; puts Spearly::VERSION")
+
+git commit -m "v$new_version"
+git tag -a v$new_version -m "Release $new_version"
+
+git push origin main
+git push origin --tags
 ```
 
 ## Publish
 ### Build
 ```sh
-$ rake build
+rake build
 ```
 
 ### Push to RubyGems
 ```sh
-$ gem push pkg/spearly-sdk-ruby-x.y.z.gem
+new_version=$(ruby -e "require './lib/spearly/version'; puts Spearly::VERSION")
+
+gem push pkg/spearly-sdk-ruby-$new_version.gem
 ```

data/lib/spearly/auth/authorizer.rb

@@ -12,18 +12,26 @@ module Spearly
 
       def method_missing(name, *args)
         @client.send(name, *args)
+      rescue Signet::AuthorizationError
+        raise Spearly::Auth::AuthorizationError
       end
 
       private
 
       def initialize_client
+        Faraday.default_connection_options = {
+          headers: {
+            'Accept' => 'application/vnd.spearly.v2+json'
+          }
+        }
+
         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_AUTH_API_URL']}/api/v1/oauth/authorize"
-        client.token_credential_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/token"
+        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']

data/lib/spearly/auth/client.rb

@@ -0,0 +1,128 @@
+module Spearly
+  module Auth
+    class Client
+      def initialize(token)
+        @token = token
+      end
+
+      def create_team(params)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.post(uri_parsed,
+                          params.as_json,
+                          'Accept' => 'application/vnd.spearly.v2+json',
+                          'Authorization' => @token)
+
+        if res.status == 201
+          JSON.parse(res.body)['data']
+        else
+          {}
+        end
+      end
+
+      def get_team(team_id)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(uri_parsed,
+                         nil,
+                         'Accept' => 'application/vnd.spearly.v2+json',
+                         'Authorization' => @token)
+
+        if res.status == 200
+          JSON.parse(res.body)['data']
+        else
+          {}
+        end
+      end
+
+      def get_teams(params = {})
+        uri = "#{ENV['SPEARLY_API_URL']}/teams"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(uri_parsed,
+                         params.as_json,
+                         'Accept' => 'application/vnd.spearly.v2+json',
+                         'Authorization' => @token)
+
+        if res.status == 200
+          JSON.parse(res.body)['data']
+        else
+          []
+        end
+      end
+
+      def update_team(team_id, params)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.put(uri_parsed,
+                         params.as_json,
+                         'Accept' => 'application/vnd.spearly.v2+json',
+                         'Authorization' => @token)
+
+        if res.status == 200
+          JSON.parse(res.body)['data']
+        else
+          nil
+        end
+      end
+
+      def regenerate_team_api_access_token(team_id)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/regenerate_api_access_token"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.post(uri_parsed,
+                          nil,
+                          'Accept' => 'application/vnd.spearly.v2+json',
+                          'Authorization' => @token)
+
+        if res.status == 200
+          JSON.parse(res.body)['data']
+        else
+          nil
+        end
+      end
+
+      def invite_user_to_team(team_id, params)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/invite"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.post(uri_parsed,
+                          params.as_json,
+                          'Accept' => 'application/vnd.spearly.v2+json',
+                          'Authorization' => @token)
+
+        if res.status == 201
+          JSON.parse(res.body)['data']
+        else
+          nil
+        end
+      end
+
+      def get_team_members(team_id)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/members"
+        uri_parsed = Addressable::URI.parse(uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(uri_parsed,
+                         nil,
+                         'Accept' => 'application/vnd.spearly.v2+json',
+                         'Authorization' => @token)
+
+        if res.status == 200
+          JSON.parse(res.body)['data']
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/spearly/auth/oauth_user.rb

@@ -6,22 +6,22 @@ require 'faraday'
 module Spearly
   module Auth
     class OauthUser
-      attr_reader :attributes
+      attr_reader :data
 
-      def initialize(attributes)
-        @attributes = attributes
+      def initialize(data)
+        @data = data
       end
 
       def method_missing(name, *_args)
-        @attributes[name.to_s]
+        @data[name.to_s]
       end
 
       def to_json(*_args)
-        @attributes.to_json
+        @data.to_json
       end
 
       def as_json
-        @attributes.as_json
+        @data.as_json
       end
     end
   end

data/lib/spearly/auth/rails/helpers.rb

@@ -13,18 +13,16 @@ module Spearly
         def spearly_token
           @spearly_token ||= begin
             token = Spearly::Auth::Token.new(request.authorization)
-            token.info
 
-            token
+            token.info ? token : nil
           end
         end
 
         def spearly_user
           @spearly_user ||= begin
             user = Spearly::Auth::User.new(request.authorization)
-            user.find
 
-            user
+            user.find ? user : nil
           end
         end
       end

data/lib/spearly/auth/team.rb

@@ -1,27 +1,24 @@
 # frozen_string_literal: true
 
-require 'addressable/uri'
-require 'faraday'
-
 module Spearly
   module Auth
     class Team
-      attr_reader :attributes
+      attr_reader :data
 
-      def initialize(attributes)
-        @attributes = attributes
+      def initialize(data)
+        @data = data
       end
 
       def method_missing(name, *_args)
-        @attributes[name.to_s]
+        @data[name.to_s]
       end
 
       def to_json(*_args)
-        @attributes.to_json
+        @data.to_json
       end
 
       def as_json
-        @attributes.as_json
+        @data.as_json
       end
     end
   end

data/lib/spearly/auth/token.rb

@@ -6,37 +6,33 @@ require 'faraday'
 module Spearly
   module Auth
     class Token
-      attr_reader :attributes, :token
+      attr_reader :data, :token
 
       def initialize(token)
         @token = token
       end
 
       def method_missing(name, *_args)
-        @attributes[name.to_s]
+        @data[name.to_s]
       end
 
       def info
-        token_info_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/token/info"
+        token_info_uri = "#{ENV['SPEARLY_API_URL']}/oauth/token/info"
         url = Addressable::URI.parse(token_info_uri).normalize.to_s
         client = Faraday.default_connection
 
         res = client.get(url,
                          nil,
+                         'Accept' => 'application/vnd.spearly.v2+json',
                          'Authorization' => @token)
 
-        case res.status
-        when 401
-          raise Spearly::Auth::AuthorizationError
-        when 500
-          raise Spearly::Auth::ServerError
-        end
+        return unless res.status == 200
 
-        @attributes = JSON.parse(res.body)
+        @data = JSON.parse(res.body)
       end
 
       def revoke(params)
-        token_revoke_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/revoke"
+        token_revoke_uri = "#{ENV['SPEARLY_API_URL']}/oauth/revoke"
         url = Addressable::URI.parse(token_revoke_uri).normalize.to_s
         client = Faraday.default_connection
 
@@ -51,11 +47,11 @@ module Spearly
       end
 
       def to_json(*_args)
-        @attributes.to_json
+        @data.to_json
       end
 
       def as_json
-        @attributes.as_json
+        @data.as_json
       end
     end
   end

data/lib/spearly/auth/user.rb

@@ -6,87 +6,56 @@ require 'faraday'
 module Spearly
   module Auth
     class User
-      attr_reader :attributes
+      attr_reader :data
 
       def initialize(token)
         @token = token
       end
 
       def method_missing(name, *_args)
-        @attributes[name.to_s]
+        @data[name.to_s]
       end
 
       def find
-        user_profile_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/profile"
+        user_profile_uri = "#{ENV['SPEARLY_API_URL']}/profile"
         url = Addressable::URI.parse(user_profile_uri).normalize.to_s
         client = Faraday.default_connection
 
         res = client.get(url,
                          nil,
+                         'Accept' => 'application/vnd.spearly.v2+json',
                          'Authorization' => @token)
 
-        case res.status
-        when 401
-          raise Spearly::Auth::AuthorizationError
-        when 500
-          raise Spearly::Auth::ServerError
-        end
+        return unless res.status == 200
 
-        @attributes = JSON.parse(res.body)['user']
+        @data = JSON.parse(res.body)['data']
       end
 
       def teams
-        teams_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/teams"
+        teams_uri = "#{ENV['SPEARLY_API_URL']}/teams"
         url = Addressable::URI.parse(teams_uri).normalize.to_s
         client = Faraday.default_connection
 
         res = client.get(url,
                          nil,
+                         'Accept' => 'application/vnd.spearly.v2+json',
                          'Authorization' => @token)
 
-        case res.status
-        when 401
-          raise Spearly::Auth::AuthorizationError
-        when 500
-          raise Spearly::Auth::ServerError
-        end
+        return [] unless res.status == 200
 
-        team_hashes = JSON.parse(res.body)['teams']
+        team_hashes = JSON.parse(res.body)['data']
 
         team_hashes.map do |team_hash|
           Spearly::Auth::Team.new(team_hash)
         end
       end
 
-      def oauth_users
-        oauth_users_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth_users"
-        url = Addressable::URI.parse(oauth_users_uri).normalize.to_s
-        client = Faraday.default_connection
-
-        res = client.get(url,
-                         nil,
-                         'Authorization' => @token)
-
-        case res.status
-        when 401
-          raise Spearly::Auth::AuthorizationError
-        when 500
-          raise Spearly::Auth::ServerError
-        end
-
-        oauth_user_hashes = JSON.parse(res.body)['oauth_users']
-
-        oauth_user_hashes.map do |oauth_user_hash|
-          Spearly::Auth::OauthUser.new(oauth_user_hash)
-        end
-      end
-
       def to_json(*_args)
-        @attributes.to_json
+        @data.to_json
       end
 
       def as_json
-        @attributes.as_json
+        @data.as_json
       end
     end
   end

data/lib/spearly/auth.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'auth/authorizer'
+require_relative 'auth/client'
 require_relative 'auth/engine'
 require_relative 'auth/oauth_user'
 require_relative 'auth/team'

data/lib/spearly/version.rb

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

data/spearly.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = Gem::Requirement.new('>= 2.7.2')
   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/CHANGELOG.md'
+  gem.metadata['changelog_uri'] = "https://github.com/unimal-jp/spearly-sdk-ruby/blob/v#{Spearly::VERSION}/CHANGELOG.md"
 
   gem.files = `git ls-files`.split("\n")
   gem.executables   = 'spearly'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spearly-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Spearly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -142,7 +142,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
@@ -151,6 +150,7 @@ files:
 - lib/spearly.rb
 - lib/spearly/auth.rb
 - lib/spearly/auth/authorizer.rb
+- lib/spearly/auth/client.rb
 - lib/spearly/auth/engine.rb
 - lib/spearly/auth/oauth_user.rb
 - lib/spearly/auth/rails/helpers.rb
@@ -166,7 +166,7 @@ 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/CHANGELOG.md
+  changelog_uri: https://github.com/unimal-jp/spearly-sdk-ruby/blob/v0.5.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/Gemfile.lock

@@ -1,93 +0,0 @@
-PATH
-  remote: .
-  specs:
-    spearly-sdk-ruby (0.2.3)
-      addressable (~> 2.3)
-      faraday (>= 0.17.4, < 2.0)
-      rake (~> 13.0)
-      signet (~> 0.15)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    faraday (1.4.2)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
-    jwt (2.2.3)
-    method_source (1.0.0)
-    multi_json (1.15.0)
-    multipart-post (2.1.1)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.15.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.5.0)
-      parser (>= 3.0.1.1)
-    rubocop-rspec (2.3.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    signet (0.15.0)
-      addressable (~> 2.3)
-      faraday (>= 0.17.3, < 2.0)
-      jwt (>= 1.5, < 3.0)
-      multi_json (~> 1.10)
-    unicode-display_width (2.0.0)
-
-PLATFORMS
-  x86_64-darwin-20
-
-DEPENDENCIES
-  pry (~> 0.13.1)
-  rspec (~> 3.0)
-  rubocop (~> 1.15)
-  rubocop-rspec (~> 2.3)
-  spearly-sdk-ruby!
-
-BUNDLED WITH
-   2.2.15