spearly-sdk-ruby 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab93721045a9b8f2ead92c04440eda2c8faef76403b848cf180189d472c77bc9
-  data.tar.gz: 959156de05c9fb6b2e9c1404f7a83b2655d463bec7e50de1008f005ba3d60abe
+  metadata.gz: c6ca2e7efcf2a6ef0c4c933c9edd49115fc2c82c5d601c34a84c76ca87bd1602
+  data.tar.gz: 2e924b9bf892c8504034bf654acdda7f28d6bdc36cc01b1bc915f6333b4c5648
 SHA512:
-  metadata.gz: 59e5178100f250cee3e175f8b7028bb5de5e63b3d626e5d85d2fcf9f8fd56f132d832af3942005b8379aa48c025ba462bbb41369133446251e415ecef248b7cd
-  data.tar.gz: 586f8d172e9e38d1af0e7d8d50d6ed600f752ee9adb0436ac4aa3428233fb18f486bb71001e774c2853649754ef8227ed125ad2c18df27855feb1933c5adc9a7
+  metadata.gz: c73bf97ee424325e8032d2719e25dc38cdfd369fac1f3775af89324f152c513c1a147a3082fefe83dab2b39d03e7f303a75c4a38a54a4e7fbdc5d1fd1c564fb9
+  data.tar.gz: aa26cc8cb81db6f9587439fc297915deaf88c5bc61e83266390f25a9e6f37da2571de3eb17f040c12dfb8ad10d5800f8d7385ee4fb48fa813d9dc2b9527fb9fd

data/CHANGELOG.md

@@ -1,10 +1,27 @@
+## [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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spearly-sdk-ruby (0.2.0)
+    spearly-sdk-ruby (0.3.1)
       addressable (~> 2.3)
       faraday (>= 0.17.4, < 2.0)
       rake (~> 13.0)
@@ -10,24 +10,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.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 (1.7.1)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       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-httpclient (1.0.1)
     faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
     jwt (2.2.3)
     method_source (1.0.0)
     multi_json (1.15.0)
@@ -40,7 +46,7 @@ GEM
       method_source (~> 1.0)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -71,9 +77,9 @@ GEM
       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)
+    ruby2_keywords (0.0.5)
+    signet (0.16.0)
+      addressable (~> 2.8)
       faraday (>= 0.17.3, < 2.0)
       jwt (>= 1.5, < 3.0)
       multi_json (~> 1.10)
@@ -81,6 +87,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   pry (~> 0.13.1)

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/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

@@ -6,22 +6,22 @@ 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,32 +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)
 
         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
 
@@ -46,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,72 +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)
 
         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)
 
-        return unless res.status == 200
+        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)
-
-        return unless res.status == 200
-
-        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

@@ -11,6 +11,7 @@ module Spearly
   module Auth
     class Error < StandardError; end
     class AuthorizationError < Error; end
+    class ServerError < Error; end
 
     module Rails
       autoload :Helpers, 'spearly/auth/rails/helpers'

data/lib/spearly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Spearly
-  VERSION = '0.2.2'
+  VERSION = '0.4.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.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Spearly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -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.4.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: