omniauth-shikimori-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ea04efed2f5b8f6ca5175c9f2ab0620971c6026a42e41c693a4b0744b7414150
+  data.tar.gz: 7bdc09bf37f87db1ad37317b072833dc1831a998a4d70c9080fc40190afd2568
+SHA512:
+  metadata.gz: '07392bb0a496168eac6d7c920b681071381feff7e1ebeb4d9d500b344fa48f7aa16bc5e8f47f571c5b4f12d7d3b802e435537f8b2954ac5d192f47f942b8f581'
+  data.tar.gz: 3efdae723a41f72409328e153f12a97a4927da1935b646c3155ae9f1627b02d49ea779b82a1be1ea4534e84fa63d545165042eff6c616a051e1937cdcd0f8890

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/omniauth/shikimori/version.rb

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

data/lib/omniauth/shikimori.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'oauth2'
+require 'omniauth/strategies/oauth2'
+require 'shikimori-oauth2'
+
+require_relative 'shikimori/version'
+require_relative 'strategies/shikimori'

data/lib/omniauth/strategies/shikimori.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Strategies
+    # OmnAuth strategy for Shikimori
+    #
+    # @see https://github.com/omniauth/omniauth-oauth2 Official repository for OmniAuth OAuth2
+    class Shikimori < OAuth2
+      USER_INFO_PATH = 'api/users/whoami'
+
+      option :name, :shikimori
+      option :client_options, site: ::Shikimori::OAuth2::Config::DEFAULT_SITE_URL
+      option :app_name, ::Shikimori::OAuth2::Config::DEFAULT_APP_NAME
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          nickname: raw_info['nickname'],
+          name: raw_info['name'],
+          gender: raw_info['sex'],
+          locale: raw_info['locale'],
+          avatar_url: raw_info['avatar'],
+          website: raw_info['website'],
+          birthday: raw_info['birth_on'],
+          urls: { shikimori: raw_info['url'] }
+        }
+      end
+
+      def client
+        @client ||= ::Shikimori::OAuth2::Client.new(
+          options.client_id,
+          options.client_secret,
+          deep_symbolize(options.client_options),
+          app_name: options.app_name
+        )
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get(info_uri).parsed
+      end
+
+      private
+
+      def info_uri
+        URI.join(client.site, USER_INFO_PATH)
+      end
+    end
+  end
+end

data/lib/omniauth-shikimori-oauth2.rb

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

data/omniauth-shikimori-oauth2.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/omniauth/shikimori/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'omniauth-shikimori-oauth2'
+  spec.version = OmniAuth::Shikimori::VERSION
+  spec.authors = ['Ivan Naumov']
+  spec.email = ['ivannaymov@gmail.com']
+
+  spec.summary = 'OmnAuth strategy for Shikimori'
+  spec.description = 'Strategy to authenticate with Shikimori via OAuth2 in OmniAuth.'
+  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',
+    'omniauth-shikimori-oauth2.gemspec',
+    # Code
+    'lib/omniauth-shikimori-oauth2.rb',
+    'lib/omniauth/**/*',
+    # Signatures
+    'sig/omniauth/**/*'
+  ]
+  spec.bindir = 'bin'
+  spec.executables = []
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'omniauth-oauth2', '~> 1.8'
+  spec.add_dependency 'shikimori-oauth2', '~> 1.0.0'
+end

data/sig/omniauth/shikimori/version.rbs

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

data/sig/omniauth/shikimori.rbs

@@ -0,0 +1,4 @@
+module OmniAuth
+  module Shikimori
+  end
+end

data/sig/omniauth/strategies/oauth2.rbs

@@ -0,0 +1,23 @@
+module OmniAuth
+  module Strategies
+    class OAuth2
+      interface _Response
+        def parsed: () -> ::Hash[_ToS, Object]
+      end
+
+      interface _AccessToken
+        def get: (::URI::Generic) -> _Response
+      end
+
+      def self.option: (Symbol, ?Object) -> void
+      def self.uid: () { -> Object } -> void
+      def self.info: () { -> ::Hash[_ToS, Object] } -> void
+
+      @raw_info: ::Hash[String, Object]
+      def raw_info: -> ::Hash[_ToS, Object]
+      def self.raw_info: -> ::Hash[_ToS, Object]
+      def access_token: -> _AccessToken
+      def deep_symbolize: (::Hash[_ToS, Object]) -> ::Hash[_ToS, Object]
+    end
+  end
+end

data/sig/omniauth/strategies/shikimori.rbs

@@ -0,0 +1,22 @@
+module OmniAuth
+  module Strategies
+    class Shikimori < OAuth2
+      interface _Options
+        def client_id: -> String
+        def client_secret: -> String
+        def client_options: -> ::Hash[Symbol, Object]
+        def app_name: -> String
+      end
+
+      USER_INFO_PATH: String
+      @client: ::Shikimori::OAuth2::Client
+
+      attr_reader options: _Options
+      def client: -> ::Shikimori::OAuth2::Client
+
+      private
+
+      def info_uri: -> ::URI::Generic
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-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: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: shikimori-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Strategy to authenticate with Shikimori via OAuth2 in OmniAuth.
+email:
+- ivannaymov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/omniauth-shikimori-oauth2.rb
+- lib/omniauth/shikimori.rb
+- lib/omniauth/shikimori/version.rb
+- lib/omniauth/strategies/shikimori.rb
+- omniauth-shikimori-oauth2.gemspec
+- sig/omniauth/shikimori.rbs
+- sig/omniauth/shikimori/version.rbs
+- sig/omniauth/strategies/oauth2.rbs
+- sig/omniauth/strategies/shikimori.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: OmnAuth strategy for Shikimori
+test_files: []