spearly-sdk-ruby 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab93721045a9b8f2ead92c04440eda2c8faef76403b848cf180189d472c77bc9
+  data.tar.gz: 959156de05c9fb6b2e9c1404f7a83b2655d463bec7e50de1008f005ba3d60abe
+SHA512:
+  metadata.gz: 59e5178100f250cee3e175f8b7028bb5de5e63b3d626e5d85d2fcf9f8fd56f132d832af3942005b8379aa48c025ba462bbb41369133446251e415ecef248b7cd
+  data.tar.gz: 586f8d172e9e38d1af0e7d8d50d6ed600f752ee9adb0436ac4aa3428233fb18f486bb71001e774c2853649754ef8227ed125ad2c18df27855feb1933c5adc9a7

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+require: rubocop-rspec
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  Exclude:
+    - 'bin/**/*'
+Layout/EmptyLineBetweenDefs:
+  Enabled: false
+Layout/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/ClassLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MessageSpies:
+  EnforcedStyle: 'receive'
+RSpec/MultipleExpectations:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/HashSyntax:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## [0.2.2] - 2021-06-11
+
+- Updates README and gem specs
+
+## [0.2.1] - 2021-05-31
+
+- Initialize Spearly::Auth::User with bearer token
+
+## [0.2.0] - 2021-05-31
+
+- `Rails` controller helpers
+- `Token`, `User` and `Team` classes
+
+## [0.1.0] - 2021-05-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    spearly-sdk-ruby (0.2.0)
+      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

data/README.md

@@ -0,0 +1,32 @@
+# Spearly SDK Ruby
+
+Spearly SDK for Ruby.
+
+## Install
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'spearly-sdk-ruby', '~> 0.2.2', require: 'spearly'
+```
+
+And then execute:
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+```sh
+$ gem install spearly-sdk-ruby
+```
+
+## Publish
+### Build
+```sh
+$ rake build
+```
+
+### Push to RubyGems
+```sh
+$ gem push pkg/spearly-sdk-ruby-x.y.z.gem
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'spearly'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/spearly

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'spearly'

data/lib/spearly.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'spearly/auth'
+require_relative 'spearly/version'
+
+module Spearly
+end

data/lib/spearly/auth.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'auth/authorizer'
+require_relative 'auth/engine'
+require_relative 'auth/oauth_user'
+require_relative 'auth/team'
+require_relative 'auth/token'
+require_relative 'auth/user'
+
+module Spearly
+  module Auth
+    class Error < StandardError; end
+    class AuthorizationError < Error; end
+
+    module Rails
+      autoload :Helpers, 'spearly/auth/rails/helpers'
+    end
+  end
+end

data/lib/spearly/auth/authorizer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'signet/oauth_2/client'
+
+module Spearly
+  module Auth
+    class Authorizer
+      def initialize(params)
+        @params = params
+        @client = initialize_client
+      end
+
+      def method_missing(name, *args)
+        @client.send(name, *args)
+      end
+
+      private
+
+      def initialize_client
+        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.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
+      end
+    end
+  end
+end

data/lib/spearly/auth/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Spearly
+  module Auth
+    class Engine < ::Rails::Engine
+      initializer 'spearly.helpers' do
+        ActiveSupport.on_load(:action_controller) do
+          include Spearly::Auth::Rails::Helpers
+        end
+      end
+    end
+  end
+end

data/lib/spearly/auth/oauth_user.rb

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Spearly
+  module Auth
+    module Rails
+      module Helpers
+        def spearly_authorize!
+          raise Spearly::Auth::AuthorizationError unless spearly_token
+        end
+
+        private
+
+        def spearly_token
+          @spearly_token ||= begin
+            token = Spearly::Auth::Token.new(request.authorization)
+            token.info
+
+            token
+          end
+        end
+
+        def spearly_user
+          @spearly_user ||= begin
+            user = Spearly::Auth::User.new(request.authorization)
+            user.find
+
+            user
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spearly/auth/team.rb

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

data/lib/spearly/auth/token.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+require 'faraday'
+
+module Spearly
+  module Auth
+    class Token
+      attr_reader :attributes, :token
+
+      def initialize(token)
+        @token = token
+      end
+
+      def method_missing(name, *_args)
+        @attributes[name.to_s]
+      end
+
+      def info
+        token_info_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/token/info"
+        url = Addressable::URI.parse(token_info_uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(url,
+                         nil,
+                         'Authorization' => @token)
+
+        return unless res.status == 200
+
+        @attributes = JSON.parse(res.body)
+      end
+
+      def revoke(params)
+        token_revoke_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/revoke"
+        url = Addressable::URI.parse(token_revoke_uri).normalize.to_s
+        client = Faraday.default_connection
+
+        bearer_token = @token.gsub(/^Bearer /i, '')
+
+        client.post(url,
+                    {
+                      client_id: params[:client_id],
+                      client_secret: params[:client_secret],
+                      token: bearer_token
+                    })
+      end
+
+      def to_json(*_args)
+        @attributes.to_json
+      end
+
+      def as_json
+        @attributes.as_json
+      end
+    end
+  end
+end

data/lib/spearly/auth/user.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'addressable/uri'
+require 'faraday'
+
+module Spearly
+  module Auth
+    class User
+      attr_reader :attributes
+
+      def initialize(token)
+        @token = token
+      end
+
+      def method_missing(name, *_args)
+        @attributes[name.to_s]
+      end
+
+      def find
+        user_profile_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/oauth/profile"
+        url = Addressable::URI.parse(user_profile_uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(url,
+                         nil,
+                         'Authorization' => @token)
+
+        return unless res.status == 200
+
+        @attributes = JSON.parse(res.body)['user']
+      end
+
+      def teams
+        teams_uri = "#{ENV['SPEARLY_AUTH_API_URL']}/api/v1/teams"
+        url = Addressable::URI.parse(teams_uri).normalize.to_s
+        client = Faraday.default_connection
+
+        res = client.get(url,
+                         nil,
+                         'Authorization' => @token)
+
+        return unless res.status == 200
+
+        team_hashes = JSON.parse(res.body)['teams']
+
+        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
+      end
+
+      def as_json
+        @attributes.as_json
+      end
+    end
+  end
+end

data/lib/spearly/version.rb

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

data/spearly.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/spearly/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'spearly-sdk-ruby'
+  gem.version       = Spearly::VERSION
+  gem.author        = 'Spearly'
+  gem.email         = ['djgrill@unimal.jp']
+
+  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.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.files = `git ls-files`.split("\n")
+  gem.executables   = 'spearly'
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rake', '~> 13.0'
+
+  gem.add_runtime_dependency 'addressable', '~> 2.3'
+  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 'rubocop', '~> 1.15'
+  gem.add_development_dependency 'rubocop-rspec', '~> 2.3'
+end

data/spec/spearly_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Spearly do
+  it 'has a version number' do
+    expect(Spearly::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spearly'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: spearly-sdk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Spearly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- djgrill@unimal.jp
+executables:
+- spearly
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/spearly
+- lib/spearly.rb
+- lib/spearly/auth.rb
+- lib/spearly/auth/authorizer.rb
+- lib/spearly/auth/engine.rb
+- lib/spearly/auth/oauth_user.rb
+- lib/spearly/auth/rails/helpers.rb
+- lib/spearly/auth/team.rb
+- lib/spearly/auth/token.rb
+- lib/spearly/auth/user.rb
+- lib/spearly/version.rb
+- spearly.gemspec
+- spec/spearly_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/unimal-jp/spearly-sdk-ruby
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.13
+signing_key: 
+specification_version: 4
+summary: Spearly SDK for Ruby
+test_files: []