shikimori-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db6330805d175e1501e7f35c7be342dcd93fe25c71683006f40812d50a455977
+  data.tar.gz: 680f3e744b7ffb4f3bf004b6bfd9ccdf0fbfc561566b923ffecc2612a63d46ae
+SHA512:
+  metadata.gz: '0969c3b8eaa1ea143cbe6a0123c8d81143756215e532106f5d3eb5c134a5d01b5f87759a50d9a9ca13e24d79fc8378edf780d8e393411ef3d886455f314cf54b'
+  data.tar.gz: f515c3178a56b7a99d939519cf23bfd1ca9a75e9fbda9b218cf4f30d57f6808a9af3e8ec36cccee824bb70e0726ae549f07280c8ff60d751f26747a6b501d7e2

data/README.md

@@ -0,0 +1,20 @@
+[![CI](https://github.com/iwdt/shikikit/actions/workflows/main.yml/badge.svg)](https://github.com/iwdt/shikikit/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/iwdt/shikikit/graph/badge.svg)](https://codecov.io/gh/iwdt/shikikit)
+
+# Shikikit
+Ruby toolkit for the [Shikimori API](https://shikimori.one)
+
+## TODO:
+- logger
+- #as_app
+- proxy config
+- oauth methods on API
+- optional auto refresh token
+- more information at errors
+- more tests
+- entities for responses
+- contracts for requests (client-side validations)
+- better documentation
+- mutator
+- CI/CD
+- auto version increment on main branch pushing
+- deploy to rubygems

data/lib/shikimori/oauth2/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module OAuth2
+    # Client for Shikimori OAuth2
+    class Client < ::OAuth2::Client
+      SCOPE_JOIN_SYMBOL = '+'
+      SCOPE_JOIN_ENCODED_SYMBOL = '%2B'
+
+      def initialize(
+        client_id,
+        client_secret,
+        options = {},
+        app_name: config.app_name,
+        &block
+      )
+        options = config.options.merge(options)
+
+        @app_name = app_name
+
+        super(client_id, client_secret, options, &block)
+      end
+
+      def authorize_url(params = {})
+        # Shikimori only works with `+` sign, not encoded value
+        super(params).gsub(SCOPE_JOIN_ENCODED_SYMBOL, SCOPE_JOIN_SYMBOL)
+      end
+
+      def get_token(params, access_token_opts = {}, extract_access_token = nil, &block)
+        params[:headers] ||= {}
+        params[:headers]['User-Agent'] ||= @app_name
+
+        super(params, access_token_opts, extract_access_token, &block)
+      end
+
+      def config
+        @config ||= OAuth2.config
+      end
+    end
+  end
+end

data/lib/shikimori/oauth2/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module OAuth2
+    # Configuration for Shikimori OAuth2 client
+    class Config
+      DEFAULT_SITE_URL = 'https://shikimori.one/'
+      DEFAULT_APP_NAME = 'Api Test'
+
+      attr_accessor :options, :site, :app_name
+
+      def initialize(site: DEFAULT_SITE_URL, app_name: DEFAULT_APP_NAME, **options)
+        @app_name = app_name
+        @options = { site: site }.merge(options)
+      end
+    end
+  end
+end

data/lib/shikimori/oauth2/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Shikimori
+  module OAuth2
+    # @return [String] Semantic version of library
+    VERSION = '1.0.0'
+  end
+end

data/lib/shikimori/oauth2.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+
+require_relative 'oauth2/config'
+require_relative 'oauth2/client'
+
+module Shikimori
+  # Tools for Shikimori OAuth2
+  #
+  # @see https://shikimori.one/oauth Official documentation
+  module OAuth2
+    class << self
+      def config
+        @config ||= Config.new
+      end
+
+      def configure
+        yield(config)
+      end
+    end
+  end
+end

data/lib/shikimori-oauth2.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'shikimori/oauth2'

data/shikimori-oauth2.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'lib/shikimori/oauth2/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'shikimori-oauth2'
+  spec.version = Shikimori::OAuth2::VERSION
+  spec.authors = ['Ivan Naumov']
+  spec.email = ['ivannaymov@gmail.com']
+
+  spec.summary = 'Simple wrapper for the Shikimori OAuth2'
+  spec.description = 'Ruby toolkit for working with the Shikimori OAuth2'
+  spec.homepage = 'https://github.com/iwdt/shikikit'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['source_code_uri'] = 'https://github.com/iwdt/shikikit'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/iwdt/shikikit/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/iwdt/shikikit/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir[
+    # Common files
+    'LICENSE',
+    'README.md',
+    'shikimori-oauth2.gemspec',
+    # Code
+    'lib/shikimori-oauth2.rb',
+    'lib/shikimori/oauth2.rb',
+    'lib/shikimori/oauth2/**/*',
+    # Signtures
+    'sig/shikimori/oauth2.rbs',
+    'sig/shikimori/oauth2/**/*'
+  ]
+  spec.bindir = 'bin'
+  spec.executables = []
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'oauth2', '~> 2.0.0'
+end

data/sig/shikimori/oauth2/client.rbs

@@ -0,0 +1,15 @@
+module Shikimori
+  module OAuth2
+    class Client < ::OAuth2::Client
+      SCOPE_JOIN_SYMBOL: String
+      SCOPE_JOIN_ENCODED_SYMBOL: String
+      @config: Config
+      @app_name: String
+      attr_reader site: URI::Generic
+
+      def initialize: (String client_id, String client_secret, ?Hash[_ToS, untyped] options, ?app_name: String) -> void
+
+      def config: -> Config
+    end
+  end
+end

data/sig/shikimori/oauth2/config.rbs

@@ -0,0 +1,14 @@
+module Shikimori
+  module OAuth2
+    class Config
+      DEFAULT_SITE_URL: String
+      DEFAULT_APP_NAME: String
+
+      attr_accessor options: Hash[Symbol, untyped]
+      attr_accessor site: String
+      attr_accessor app_name: String
+
+      def initialize: (?site: String, ?app_name: String, **untyped) -> void
+    end
+  end
+end

data/sig/shikimori/oauth2/version.rbs

@@ -0,0 +1,5 @@
+module Shikimori
+  module OAuth2
+    VERSION: String
+  end
+end

data/sig/shikimori/oauth2.rbs

@@ -0,0 +1,8 @@
+module Shikimori
+  module OAuth2
+    self.@config: Config
+
+    def self.config: -> Config
+    def self.configure: { (Config) -> Config } -> void
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: shikimori-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ivan Naumov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Ruby toolkit for working with the Shikimori OAuth2
+email:
+- ivannaymov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shikimori-oauth2.rb
+- lib/shikimori/oauth2.rb
+- lib/shikimori/oauth2/client.rb
+- lib/shikimori/oauth2/config.rb
+- lib/shikimori/oauth2/version.rb
+- shikimori-oauth2.gemspec
+- sig/shikimori/oauth2.rbs
+- sig/shikimori/oauth2/client.rbs
+- sig/shikimori/oauth2/config.rbs
+- sig/shikimori/oauth2/version.rbs
+homepage: https://github.com/iwdt/shikikit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/iwdt/shikikit
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/iwdt/shikikit
+  bug_tracker_uri: https://github.com/iwdt/shikikit/issues
+  changelog_uri: https://github.com/iwdt/shikikit/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Simple wrapper for the Shikimori OAuth2
+test_files: []