spearly-sdk-ruby 0.2.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67814c681befa771a269e339b41cd446c68bdc242dd3a61900c3a1f507165167
-  data.tar.gz: ae7c1f34d649ebc34c0bd8ec4d1e468542c5c7c13bbf351fc0c9e3c294010996
+  metadata.gz: b08e74792de34fcc6c4e74ff511041fe8da3f689bb61c9923e1497d6d5bfd546
+  data.tar.gz: dd8486d9492fe690cd3aae7a48960931313e4718285848364a5926cf077df2e4
 SHA512:
-  metadata.gz: b5e943c498662cd93bcaaa2a5db68e5f16129a337860f8f35637a3d4056bcda54684a5f542201017ac1642ca9dab50549a77324d5d1c7c0354178eaa92b9c88c
-  data.tar.gz: a7fff0b9890ee300d37a958cfd714057d5684dbd534fb05e7a8cd24b6f7f59c1e45fd084ab64a457da3fcbf5c2a51c437e7d11704174db4fb00b1db30040e855
+  metadata.gz: 6e1a7c46099f4a227892d2400ea8625a9b2ded28aa9a3cc178d64ba6bd6de91b17521e4174c0f72a8b5dec71bf7ecd1a795814f37c535fd4ce7fa6e17da8a99d
+  data.tar.gz: 32829ececead704d08c8ed4b43b84d23c28322ec695543d28b190e790aa51717924afdfc095cbd69dfb5b2454fb86ccae72e508774f2ab9280361ff4bdb2e019

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,3 +1,24 @@
+## [0.6.0] - 2022-01-20
+
+- `Spearly::Auth::Client#get_team_features`
+
+## [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`

data/README.md

@@ -20,29 +20,42 @@ Or install it manually:
 gem install spearly-sdk-ruby
 ```
 
-## Publish
+## Contribute
 ### Increment version
 ```sh
 vim lib/spearly/version.rb
 ```
 
-### Build
+### Update CHANGELOG
 ```sh
-rake build
+vim CHANGELOG.md
 ```
 
-### Push to RubyGems
+### Update Gemfile.lock
 ```sh
-new_version=$(ruby -e "require 'spearly/version'; puts Spearly::VERSION")
-
-gem push pkg/spearly-sdk-ruby-$new_version.gem
+bundle install
 ```
 
-## Contribute
 ### New version commit
 ```sh
-new_version=$(ruby -e "require 'spearly/version'; puts Spearly::VERSION")
+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
+```
+
+### Push to RubyGems
+```sh
+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

@@ -19,13 +19,19 @@ module Spearly
       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,145 @@
+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
+
+      def get_team_features(team_id)
+        uri = "#{ENV['SPEARLY_API_URL']}/teams/#{team_id}/features"
+        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/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,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
 
-        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

@@ -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.4'
+  VERSION = '0.6.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/blob/#{Spearly::VERSION}/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.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Spearly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2022-01-20 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/blob/0.2.4/CHANGELOG.md
+  changelog_uri: https://github.com/unimal-jp/spearly-sdk-ruby/blob/v0.6.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