doorkeeper_jp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2a440e47c1e390029eba1e47a857b8e3ce99583b188d08413d28518ddc4dde1
+  data.tar.gz: 169312c956b7247816d054171a8d83e0dea5f4562ef934858b67b6da6a03ee49
+SHA512:
+  metadata.gz: 8951263bb1083ec732345e9a98849b81ed30c4ffe98a1514b0bd7b67b2de8fc6a288a9a2c396ba128813bc5dd2764b68fee406c73d9e21fed3fd64bdf6b633d6
+  data.tar.gz: c014e9a7cf8d66611fc032eae3a205412a05dd06dc7a912fc318e9c79bac0fd22e677644c692e75081f64ceb41859fdcdb168f5fe3c48ff2ac59b574248a9a6e

data/.rspec

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

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+--no-private
+--hide-void-return
+-
+CHANGELOG.md
+LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+[full changelog](http://github.com/sue445/doorkeeper_jp/compare/v0.1.0...main)
+
+## [0.1.0] - 2022-09-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in doorkeeper_jp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# DoorkeeperJp
+
+API client for [doorkeeper.jp](https://www.doorkeeper.jp/) 
+
+[![test](https://github.com/sue445/doorkeeper_jp/actions/workflows/test.yml/badge.svg)](https://github.com/sue445/doorkeeper_jp/actions/workflows/test.yml)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doorkeeper_jp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install doorkeeper_jp
+
+## Usage
+```ruby
+require "doorkeeper_jp"
+
+client = DoorkeeperJp.client(ENV["DOORKEEPER_ACCESS_TOKEN"])
+
+# List all featured events
+events = client.events
+
+events.count
+#=> 25
+
+events[0].title
+#=> "Kaigi on Rails 2022"
+
+events[0].public_url
+#=> "https://kaigionrails.doorkeeper.jp/events/143638"
+
+# List a community's events
+client.group_events("trbmeetup")
+
+# Show a specific event
+event = client.event(28319)
+
+event.title
+#=> "900K records per second with Ruby, Java, and JRuby"
+
+event.public_url
+#=> "https://trbmeetup.doorkeeper.jp/events/28319"
+
+# Show a specific group
+group = client.group("trbmeetup")
+
+group.name
+#=> "Tokyo Rubyist Meetup"
+
+group.public_url
+#=> "https://trbmeetup.doorkeeper.jp/"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/doorkeeper_jp.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/doorkeeper_jp.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/doorkeeper_jp/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "doorkeeper_jp"
+  spec.version = DoorkeeperJp::VERSION
+  spec.authors = ["sue445"]
+  spec.email = ["sue445@sue445.net"]
+
+  spec.summary = "API client for doorkeeper.jp"
+  spec.description = "API client for doorkeeper.jp"
+  spec.homepage = "https://github.com/sue445/doorkeeper_jp"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", ">= 2.0.0"
+  spec.add_dependency "faraday-mashify"
+  spec.add_dependency "hashie"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "yard"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/doorkeeper_jp/client.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module DoorkeeperJp
+  class Client
+    # @param access_token [String]
+    def initialize(access_token = nil)
+      @access_token = access_token
+    end
+
+    # List all featured events
+    #
+    # @param page [Integer] The page offset of the results.
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    # @param sort [String] The order of the results. One of `published_at`, `starts_at`, `updated_at`. Default: `published_at`.
+    # @param since_date [Date] Only events taking place during or after this date will be included. Default: Today.
+    # @param until_date [Date] Only events taking place during or before this date will be included.
+    # @param keyword [String] Keyword to search for from the title or description fields.
+    # @param prefecture [String] Only events with an address in prefecture.
+    # @param is_expand_group [Boolean] Expands the group object.
+    #
+    # @return [Array<DoorkeeperJp::Response>]
+    #
+    # @see https://www.doorkeeper.jp/developer/api?locale=en
+    def events(page: nil, locale: nil, sort: nil, since_date: nil, until_date: nil, keyword: nil, prefecture: nil, is_expand_group: false)
+      get_events(
+        path: "events",
+        page: page, locale: locale, sort: sort, since_date: since_date, until_date: until_date,
+        keyword: keyword, prefecture: prefecture, is_expand_group: is_expand_group,
+      )
+    end
+
+    # List a community's events
+    #
+    # @param group [String]
+    # @param page [Integer] The page offset of the results.
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    # @param sort [String] The order of the results. One of `published_at`, `starts_at`, `updated_at`. Default: `published_at`.
+    # @param since_date [Date] Only events taking place during or after this date will be included. Default: Today.
+    # @param until_date [Date] Only events taking place during or before this date will be included.
+    # @param keyword [String] Keyword to search for from the title or description fields.
+    # @param prefecture [String] Only events with an address in prefecture.
+    # @param is_expand_group [Boolean] Expands the group object.
+    #
+    # @return [Array<DoorkeeperJp::Response>]
+    #
+    # @see https://www.doorkeeper.jp/developer/api?locale=en
+    def group_events(group, page: nil, locale: nil, sort: nil, since_date: nil, until_date: nil, keyword: nil, prefecture: nil, is_expand_group: false)
+      get_events(
+        path: "groups/#{group}/events",
+        page: page, locale: locale, sort: sort, since_date: since_date, until_date: until_date,
+        keyword: keyword, prefecture: prefecture, is_expand_group: is_expand_group,
+      )
+    end
+
+    # Show a specific group
+    #
+    # @param group [String]
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    #
+    # @return [DoorkeeperJp::Response]
+    #
+    # @see https://www.doorkeeper.jp/developer/api?locale=en
+    def group(group, locale: nil)
+      params = {
+        locale: locale,
+      }.compact
+
+      res = connection.get("groups/#{group}", params).body
+      res.group
+    end
+
+    # Show a specific event
+    #
+    # @param id [Integer]
+    # @param is_expand_group [Boolean] Expands the group object.
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    #
+    # @return [DoorkeeperJp::Response]
+    #
+    # @see https://www.doorkeeper.jp/developer/api?locale=en
+    def event(id, is_expand_group: false, locale: nil)
+      params = {
+        locale: locale,
+      }.compact
+
+      params["expand[]"] = "group" if is_expand_group
+
+      res = connection.get("events/#{id}", params).body
+      res.event
+    end
+
+    private
+
+    # @param path [String]
+    # @param page [Integer] The page offset of the results.
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    # @param sort [String] The order of the results. One of `published_at`, `starts_at`, `updated_at`. Default: `published_at`.
+    # @param since_date [Date] Only events taking place during or after this date will be included. Default: Today.
+    # @param until_date [Date] Only events taking place during or before this date will be included.
+    # @param keyword [String] Keyword to search for from the title or description fields.
+    # @param prefecture [String] Only events with an address in prefecture.
+    # @param is_expand_group [Boolean] Expands the group object.
+    #
+    # @return [Array<DoorkeeperJp::Response>]
+    def get_events(path:, page:, locale:, sort:, since_date:, until_date:, keyword:, prefecture:, is_expand_group:)
+      params = event_params(
+        page: page, locale: locale, sort: sort, since_date: since_date, until_date: until_date,
+        keyword: keyword, prefecture: prefecture, is_expand_group: is_expand_group,
+      )
+
+      res = connection.get(path, params).body
+      res.map(&:event)
+    end
+
+    # @return [Faraday::Connection]
+    def connection
+      Faraday.new(url: "https://api.doorkeeper.jp/", headers: request_headers) do |conn|
+        conn.response :mashify, mash_class: DoorkeeperJp::Response
+        conn.response :json
+        conn.response :raise_error
+
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    # @return [Hash]
+    def request_headers
+      headers =
+        {
+          "User-Agent" => "DoorkeeperJp v#{DoorkeeperJp::VERSION} (https://github.com/sue445/doorkeeper_jp)",
+          "Content-Type" => "application/json",
+        }
+
+      headers["Authorization"] = "Bearer #{@access_token}" if @access_token
+
+      headers
+    end
+
+    # @param page [Integer] The page offset of the results.
+    # @param locale [String] The localized text for an event. One of `en`, `ja`. Default: `ja`.
+    # @param sort [String] The order of the results. One of `published_at`, `starts_at`, `updated_at`. Default: `published_at`.
+    # @param since_date [Date] Only events taking place during or after this date will be included. Default: Today.
+    # @param until_date [Date] Only events taking place during or before this date will be included.
+    # @param keyword [String] Keyword to search for from the title or description fields.
+    # @param prefecture [String] Only events with an address in prefecture.
+    # @param is_expand_group [Boolean] Expands the group object.
+    #
+    # @return [Hash]
+    def event_params(page:, locale:, sort:, since_date:, until_date:, keyword:, prefecture:, is_expand_group:)
+      params = {
+        page:       page,
+        locale:     locale,
+        sort:       sort,
+        since:      to_ymd(since_date),
+        until:      to_ymd(until_date),
+        q:          keyword,
+        prefecture: prefecture
+      }.compact
+
+      params["expand[]"] = "group" if is_expand_group
+
+      params
+    end
+
+    # @param date [Date]
+    #
+    # @return [String]
+    def to_ymd(date)
+      date&.strftime("%Y-%m-%d")
+    end
+  end
+end

data/lib/doorkeeper_jp/response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DoorkeeperJp
+  require "hashie/mash"
+
+  class Response < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/doorkeeper_jp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DoorkeeperJp
+  VERSION = "0.1.0"
+end

data/lib/doorkeeper_jp.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "doorkeeper_jp/version"
+require_relative "doorkeeper_jp/client"
+require_relative "doorkeeper_jp/response"
+
+require "faraday"
+require "faraday/mashify"
+
+module DoorkeeperJp
+  class Error < StandardError; end
+
+  # Create and returns {DoorkeeperJp::Client} instance
+  #
+  # @param access_token [String]
+  #
+  # @return [DoorkeeperJp::Client]
+  def self.client(access_token = nil)
+    DoorkeeperJp::Client.new(access_token)
+  end
+end

data/sig/doorkeeper_jp/client.rbs

@@ -0,0 +1,25 @@
+module DoorkeeperJp
+  class Client
+    def initialize: (?String? access_token) -> void
+
+    def events: (?page: Integer? page, ?locale: String? locale, ?sort: String? sort, ?since_date: Date? since_date, ?until_date: Date? until_date, ?keyword: String? keyword, ?prefecture: String? prefecture, ?is_expand_group: bool? is_expand_group) -> Array[DoorkeeperJp::Response]
+
+    def group_events: (String group, ?page: Integer? page, ?locale: String? locale, ?sort: String? sort, ?since_date: Date? since_date, ?until_date: Date? until_date, ?keyword: String? keyword, ?prefecture: String? prefecture, ?is_expand_group: bool? is_expand_group) -> Array[DoorkeeperJp::Response]
+
+    def group: (String group, ?locale: String? locale) -> DoorkeeperJp::Response
+
+    def event: (Integer id, ?is_expand_group: bool is_expand_group, ?locale: String? locale) -> DoorkeeperJp::Response
+
+    private
+
+    def get_events: (String path, ?page: Integer? page, ?locale: String? locale, ?sort: String? sort, ?since_date: Date? since_date, ?until_date: Date? until_date, ?keyword: String? keyword, ?prefecture: String? prefecture, ?is_expand_group: bool? is_expand_group) -> Array[DoorkeeperJp::Response]
+
+    def connection: () -> Faraday::Connection
+
+    def request_headers: () -> Hash[String, String]
+
+    def event_params: (?page: Integer page, ?locale: String locale, ?sort: String sort, ?since_date: Date since_date, ?until_date: Date until_date, ?keyword: String keyword, ?prefecture: String prefecture, ?is_expand_group: bool is_expand_group) -> Hash[Symbol, untyped]
+
+    def to_ymd: (Date? date) -> String
+  end
+end

data/sig/doorkeeper_jp/response.rbs

@@ -0,0 +1,4 @@
+module DoorkeeperJp
+  class Response < Hashie::Mash
+  end
+end

data/sig/doorkeeper_jp.rbs

@@ -0,0 +1,6 @@
+module DoorkeeperJp
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  def self.client: (?String? access_token) -> DoorkeeperJp::Client
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: doorkeeper_jp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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
+- !ruby/object:Gem::Dependency
+  name: faraday-mashify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client for doorkeeper.jp
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doorkeeper_jp.gemspec
+- lib/doorkeeper_jp.rb
+- lib/doorkeeper_jp/client.rb
+- lib/doorkeeper_jp/response.rb
+- lib/doorkeeper_jp/version.rb
+- sig/doorkeeper_jp.rbs
+- sig/doorkeeper_jp/client.rbs
+- sig/doorkeeper_jp/response.rbs
+homepage: https://github.com/sue445/doorkeeper_jp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/doorkeeper_jp
+  source_code_uri: https://github.com/sue445/doorkeeper_jp
+  changelog_uri: https://github.com/sue445/doorkeeper_jp/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: API client for doorkeeper.jp
+test_files: []