studyplus_for_school_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2e702e5c3f589aae651d73fd8792ffe2e77d363f1d31e2260372bd141f6fe6e
+  data.tar.gz: 236437dbc571d0923d29060933bfc9aafd53cee3549b242d2f17ba17460c188c
+SHA512:
+  metadata.gz: 1268f823939fd29b58ecccd8a1574af5ec7f6b9e8fff563b40e43b659d429cfd60b58e89ae57cf93bc926b4e4ea5e6418d51564066546ddc1a60682e6828f38f
+  data.tar.gz: 39adf012bec5f9d27f986e2ad273e2f70b1be5ab13475ca3650e3f336f2055ecab4fcfa462ffcd15a28b36bf3952bc978a39d794b36f9169e169f34c5046e6ce

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=6eafb21db695d9524525bbb70e8eb3f01a20329e9663451317e180a7c7d4a9de
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shimada227@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in studyplus_for_school_sync.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    studyplus_for_school_sync (0.1.0)
+      faraday
+      faraday-encoding
+      faraday_middleware
+      launchy
+      thor
+      webrick
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    diff-lcs (1.3)
+    docile (1.4.0)
+    faraday (1.4.1)
+      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-encoding (0.0.5)
+      faraday
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    ruby2_keywords (0.0.4)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    thor (1.1.0)
+    webrick (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  simplecov
+  studyplus_for_school_sync!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 shimada
+
+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,129 @@
+# StudyplusForSchoolSync
+
+[![Build Status](https://travis-ci.com/yshimada0330/studyplus_for_school_sync.svg?branch=master)](https://travis-ci.com/yshimada0330/studyplus_for_school_sync)
+[![Maintainability](https://api.codeclimate.com/v1/badges/be0e005027ea497a53db/maintainability)](https://codeclimate.com/github/yshimada0330/studyplus_for_school_sync/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/be0e005027ea497a53db/test_coverage)](https://codeclimate.com/github/yshimada0330/studyplus_for_school_sync/test_coverage)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/yshimada0330/studyplus_for_school_sync)
+[![Inline docs](https://inch-ci.org/github/yshimada0330/studyplus_for_school_sync.svg?branch=master)](http://inch-ci.org/github/yshimada0330/studyplus_for_school_sync)
+![GitHub](https://img.shields.io/github/license/yshimada0330/studyplus_for_school_sync)
+
+A Ruby Client for [Studyplus for School SYNC API](https://studyplus.github.io/fs-sync-api/)
+
+![logo](https://user-images.githubusercontent.com/7440963/124934927-251b3180-e040-11eb-82bf-04cf82021593.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'studyplus_for_school_sync', github: 'yshimada0330/studyplus_for_school_sync'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install studyplus_for_school_sync
+
+## Usage
+
+### Authorization
+
+1. Redirect Server Start: Case where the redirect server that receives authorization code is localhost
+1. Retrieve Authorization Code:
+   1. If you start localhost, run it in a different terminal
+   1. Authorize and receive the authorization code on the redirect server.
+1. Create/Refresh Token: Creating a token from authorization code
+
+Redirect Server Start:
+
+    $ bundle exec studyplus_for_school_sync server
+
+=> https://localhost:8080/
+
+If to get a token with a form
+
+    $ BASE_URL=[BASE_URL] bundle exec studyplus_for_school_sync server
+
+If you want to change the port
+
+    $ bundle exec studyplus_for_school_sync server --port 3000
+
+=> https://localhost:3000/
+
+Retrieve Authorization Code:
+
+    $ bundle exec studyplus_for_school_sync authorize [BASE_URL] [CLIENT_ID]
+
+Create/Refresh Token:
+
+```ruby
+base_url = "https://sandbox.fs-lms.studyplus.co.jp" # SYNC API URL
+client_id = "sample_id" # YOUR CLIENT_ID
+client_secret = "sample_pass" # YOUR CLIENT SECRET
+authorization_code = "xxx" # Retrieve Authorization Code
+token = StudyplusForSchoolSync::Token.new(base_url: base_url, client_id: client_id, client_secret: client_secret)
+response = token.create(authorization_code: authorization_code, redirect_uri: "https://localhost:8080")
+response.status # => 200
+response.body # => {"access_token"=>"xxx", "token_type"=>"Bearer", "expires_in"=>86399, "refresh_token"=>"xxxx", "scope"=>"learning_material_supplier lms_passcode_issue", "created_at"=>1621558627}
+
+# Refresh token
+response = token.refresh(response.body["refresh_token"])
+response.status # => 200
+response.body # => {"access_token"=>"xxx", "token_type"=>"Bearer", "expires_in"=>86399, "refresh_token"=>"xxx", "scope"=>"learning_material_supplier lms_passcode_issue", "created_at"=>1621558753}
+```
+
+### Resource Access
+
+`access_token` is the value obtained from Authorization flow.
+
+```ruby
+client = StudyplusForSchoolSync::Client.new(base_url: base_url, access_token: access_token)
+response = client.create_partner(school_name: "school A")
+response.status # => 200
+response.body # => {"public_id"=>"12345abcde"}
+
+response = client.create_student(
+  partner_public_id: response.body["public_id"],
+  last_name: "山田",
+  first_name: "太郎",
+  last_name_kana: "ヤマダ",
+  first_name_kana: "タロウ"
+)
+response.status #=> 200
+response.body # => {"public_id"=>"xxxx"}
+student_public_id = response.body["public_id"]
+
+response = client.create_learning_material(name: "text A")
+learning_material_public_id = response.body["public_id"]
+response = client.update_learning_material(learning_material_public_id: learning_material_public_id, name: "text B")
+
+response = client.create_study_record(
+  learning_material_public_id: learning_material_public_id,
+  student_public_id: student_public_id,
+  recorded_at: "2020/03/01 09:30:10",
+  number_of_seconds: 600
+)
+
+response = client.create_passcode(student_public_id)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yshimada0330/studyplus_for_school_sync. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+1. Fork it ( https://github.com/yshimada0330/studyplus_for_school_sync/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the StudyplusForSchoolSync project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yshimada0330/studyplus_for_school_sync/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "studyplus_for_school_sync"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/studyplus_for_school_sync

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "studyplus_for_school_sync"
+
+StudyplusForSchoolSync::Cli.start

data/lib/studyplus_for_school_sync.rb

@@ -0,0 +1,12 @@
+require "studyplus_for_school_sync/version"
+
+require "studyplus_for_school_sync/endpoint"
+require "studyplus_for_school_sync/client"
+require "studyplus_for_school_sync/server"
+require "studyplus_for_school_sync/authorizer"
+require "studyplus_for_school_sync/token"
+require "studyplus_for_school_sync/cli"
+
+module StudyplusForSchoolSync
+  class Error < StandardError; end
+end

data/lib/studyplus_for_school_sync/authorizer.rb

@@ -0,0 +1,37 @@
+require "uri"
+require "launchy"
+
+module StudyplusForSchoolSync
+  # Retrieve Authorization Code
+  class Authorizer
+    OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+    RESPONSE_TYPE = "code"
+    END_POINT = "learning_material_supplier_api/v1/oauth/authorize"
+    DEFAULT_SCOPES = %w(learning_material_supplier lms_passcode_issue)
+
+    attr_reader :base_url, :client_id, :redirect_uri, :scopes
+
+    # @param base_url [String] API domain
+    # @param client_id [String] ApplicationClientID
+    # @param redirect_uri [String]
+    # @param scopes [Array]
+    def initialize(base_url:, client_id:, redirect_uri: nil, scopes: DEFAULT_SCOPES)
+      @base_url = base_url
+      @client_id = client_id
+      @redirect_uri = redirect_uri || OOB_URI
+      @scopes = scopes
+    end
+
+    # Launch the browser to get the Authorization Code and authorize it.
+    def authorize
+      query = URI.encode_www_form({ client_id: client_id, response_type: RESPONSE_TYPE, redirect_uri: redirect_uri, scope: scopes.join(" ") })
+      Launchy.open(build_url(query))
+    end
+
+    private
+
+    def build_url(query)
+      "#{URI.join(base_url, END_POINT)}?#{query}"
+    end
+  end
+end

data/lib/studyplus_for_school_sync/cli.rb

@@ -0,0 +1,26 @@
+require "thor"
+
+module StudyplusForSchoolSync
+  # Command Line Tool
+  class Cli < Thor
+    DEFAULT_REDIRECT_URI = "https://localhost:8080"
+
+    desc "server", "Start the server for redirection. ex) server --port 8080"
+    option :port
+    def server
+      params = {}
+      params[:port] = options[:port] if options[:port]
+      StudyplusForSchoolSync::Server.new.start(**params)
+    end
+
+    desc "authorize [BASE_URL] [CLIENT_ID]", "Retrieve Authorization Code. ex) authorize https://xxxx.studyplus.co.jp xxxxxxxx"
+    option :redirect_uri
+    option :scopes, desc: "Specify scopes separated by commas"
+    def authorize(base_url, client_id)
+      params = { client_id: client_id, base_url: base_url, redirect_uri: DEFAULT_REDIRECT_URI }
+      params[:redirect_uri] = options[:redirect_uri] if options[:redirect_uri]
+      params[:scopes] = options[:scopes].split(",") if options[:scopes]
+      StudyplusForSchoolSync::Authorizer.new(**params).authorize
+    end
+  end
+end

data/lib/studyplus_for_school_sync/client.rb

@@ -0,0 +1,85 @@
+require "uri"
+require "json"
+require "faraday"
+require "faraday/encoding"
+require "faraday_middleware"
+
+module StudyplusForSchoolSync
+  # Sync API Http Client
+  class Client
+    include Endpoint
+
+    attr_accessor :access_token
+
+    # @param base_url [String] API domain
+    # @param access_token [String] OAuth access token
+    def initialize(base_url:, access_token: nil)
+      @base_url = base_url
+      @access_token = access_token
+      @conn = Faraday.new(headers: default_header) do |connection|
+        connection.response :json
+        connection.response :encoding
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    # GET Http Request
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Hash] API response
+    def get(path:, params: nil)
+      @conn.get(build_url(path)) do |req|
+        req.params = params if params
+      end
+    end
+
+    # POST Http Request
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Hash] API response
+    def post(path:, params: nil)
+      @conn.post(build_url(path)) do |req|
+        req.body = params.to_json if params
+      end
+    end
+
+    # PUT Http Request
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Hash] API response
+    def put(path:, params: nil)
+      @conn.put(build_url(path)) do |req|
+        req.body = params.to_json if params
+      end
+    end
+
+    # PATCH Http Request
+    # @param path [String]
+    # @param params [Hash]
+    # @return [Hash] API response
+    def patch(path:, params: nil)
+      @conn.patch(build_url(path)) do |req|
+        req.body = params.to_json if params
+      end
+    end
+
+    # DELETE Http Request
+    # @param path [String]
+    # @return [Hash] API response
+    def delete(path:)
+      @conn.delete(build_url(path))
+    end
+    
+    private
+
+    def build_url(path)
+      URI.join(@base_url, path)
+    end
+
+    def default_header
+      header = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }
+      header['Authorization'] = "Bearer #{access_token}" if access_token 
+      header
+    end
+  end
+end

data/lib/studyplus_for_school_sync/endpoint.rb

@@ -0,0 +1,13 @@
+require_relative "endpoint/learning_material"
+require_relative "endpoint/partner"
+require_relative "endpoint/student"
+
+module StudyplusForSchoolSync
+  module Endpoint
+    BASE_PAH = "learning_material_supplier_api/v1"
+
+    include LearningMaterial
+    include Partner
+    include Student
+  end
+end

data/lib/studyplus_for_school_sync/endpoint/learning_material.rb

@@ -0,0 +1,27 @@
+module StudyplusForSchoolSync
+  module Endpoint
+    module LearningMaterial
+      # Creae learning material
+      # @param name[String] learning material name
+      # @param [Hash]options
+      # @option options [String] :image_url
+      # @option options [String] :unit
+      # @option options [String] :customer_id
+      # @return [Hash] API response
+      def create_learning_material(name:, **options)
+        post(path: "#{BASE_PAH}/learning_materials", params: options.merge(name: name))
+      end
+
+      # Update learning material
+      # @param name[String] learning material name
+      # @param [Hash] options
+      # @option options [String] :image_url
+      # @option options [String] :unit
+      # @option options [String] :customer_id
+      # @return [Hash] API response
+      def update_learning_material(learning_material_public_id:, name:, **options)
+        put(path: "#{BASE_PAH}/learning_materials/#{learning_material_public_id}", params: options.merge(name: name))
+      end
+    end
+  end
+end

data/lib/studyplus_for_school_sync/endpoint/partner.rb

@@ -0,0 +1,78 @@
+module StudyplusForSchoolSync
+  module Endpoint
+    module Partner
+      # Create partner
+      # @param partner_name [String]
+      # @param [Hash] options
+      # @option options [String] :name
+      # @option options [String] :timezone
+      # @option options [String] :started_on
+      # @option options [String] :customer_id
+      # @return [Hash] API response
+      def create_partner(school_name:, **options)
+        post(path: "#{BASE_PAH}/partners", params: options.merge(school_name: school_name))
+      end
+
+      # Create student
+      # @param partner_public_id [String]
+      # @param last_name [String]
+      # @param first_name [String]
+      # @param last_name_kana [String]
+      # @param first_name_kana [String]
+      # @param [Hash] options
+      # @option options [String] :school_type
+      # @option options [String] :grade
+      # @option options [String] :code
+      # @return [Hash] API response
+      def create_student(partner_public_id:, last_name:, first_name:, last_name_kana:, first_name_kana:, **options)
+        post(
+          path: "#{BASE_PAH}/partners/#{partner_public_id}/students",
+          params: options.merge(
+            last_name: last_name,
+            first_name: first_name,
+            last_name_kana: last_name_kana,
+            first_name_kana: first_name_kana
+          )
+        )
+      end
+
+      # Get tags
+      # @param parner_id [String]
+      # @param page [Integer]
+      # @return [Hash] API response
+      def tags(partner_id:, page: 1)
+        get(path: "#{BASE_PAH}/partners/#{partner_id}/tags", params: { page: page })
+      end
+
+      # Creae tag
+      # @param partner_id [String]
+      # @param name [String]
+      # @param [Hash] options
+      # @option options [String] :customer_id
+      # @return [Hash] API response
+      def create_tag(partner_id:, name:, **options)
+        post(path: "#{BASE_PAH}/partners/#{partner_id}/tags", params: options.merge(name: name))
+      end
+
+      # Update tag
+      # @param partner_id [String]
+      # @param tag_id [String]
+      # @param name [String]
+      # @param options [Hash]
+      # @param options [String] :customer_id
+      # @return [Hash] API response
+      def update_tag(partner_id:, tag_id:, name:, **options)
+        patch(path: "#{BASE_PAH}/partners/#{partner_id}/tags/#{tag_id}", params: options.merge(name: name))
+      end
+
+      # Delete tag
+      # @param partner_id [String]
+      # @param tag_id [String]
+      # @return [Hash] API response
+      def delete_tag(partner_id:, tag_id:)
+        delete(path: "#{BASE_PAH}/partners/#{partner_id}/tags/#{tag_id}")
+      end
+    end
+  end
+end
+ 

data/lib/studyplus_for_school_sync/endpoint/student.rb

@@ -0,0 +1,83 @@
+module StudyplusForSchoolSync
+  module Endpoint
+    module Student
+      # Creae passcode
+      # @param student_id [String]
+      # @return [Hash] API response
+      def create_passcode(student_id)
+        post(path: "#{BASE_PAH}/students/#{student_id}/passcode")
+      end
+
+      # Stop passcode
+      # @param student_id [String]
+      # @return [Hash] API response
+      def inactivate_passcode(student_id)
+        delete(path: "#{BASE_PAH}/students/#{student_id}/passcode")
+      end
+
+      # Create study record
+      # @param learning_material_public_id [String]
+      # @param student_public_id [String]
+      # @param recorded_at [String]
+      # @param [Hash] options
+      # @option options [Integer] :amount
+      # @option options [Integer] :number_of_seconds
+      # @option options [Integer] :start_position
+      # @option options [Integer] :end_position
+      # @option options [String] :comment
+      # @option options [String] :external_link
+      # @option options [String] :learning_material_customer_uid
+      # @option options [String] :student_customer_uid
+      # @return [Hash] API response
+      def create_study_record(learning_material_public_id:, student_public_id:, recorded_at:, **options)
+        post(
+          path: "#{BASE_PAH}/study_records",
+          params: options.merge(
+            learning_material_public_id: learning_material_public_id,
+            student_public_id: student_public_id,
+            recorded_at: recorded_at
+          )
+        )
+      end
+
+      # Get student tags
+      # @param student_id [String]
+      # @return [Hash] API response
+      def student_tags(student_id:)
+        get(path: "#{BASE_PAH}/students/#{student_id}/tags")
+      end
+
+      # Attach student tag
+      # @param student_id [String]
+      # @param tag_id [String]
+      # @return [Hash] API response
+      def attach_student_tag(student_id:, tag_id:)
+        put(path: "#{BASE_PAH}/students/#{student_id}/tags/#{tag_id}")
+      end
+
+      # Detach student tag
+      # @param student_id [String]
+      # @param tag_id [String]
+      # @return [Hash] API response
+      def detach_student_tag(student_id:, tag_id:)
+        delete(path: "#{BASE_PAH}/students/#{student_id}/tags/#{tag_id}")
+      end
+      
+      # Ge transfer student
+      # @param student_id [String]
+      # @param transfer_id [String]
+      # @return [Hash] API response
+      def student_transfer(student_id:, transfer_id:)
+        get(path: "#{BASE_PAH}/students/#{student_id}/transfers/#{transfer_id}")
+      end
+
+      # Create transfer student
+      # @param student_id [String]
+      # @param partner_id [String]
+      # @return [Hash] API response
+      def create_student_transfer(student_id:, partner_id:)
+        post(path: "#{BASE_PAH}/students/#{student_id}/transfers", params: { partner_id: partner_id })
+      end
+    end
+  end
+end

data/lib/studyplus_for_school_sync/html/index.erb

@@ -0,0 +1,79 @@
+<html>
+    <head>
+      <meta charset="utf-8"/>
+      <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+    </head>
+    <body>
+      <div class="container">
+        <div class="row  my-3">
+          <h1>StudyplusForSchoolSync</h1>
+        </div>
+        <div class="row my-3">
+          <div class="col-6">
+            <h2>Authorization Code</h2>
+            <input class="form-control" type="text" value="<%= code %>" aria-label="readonly input example" readonly>
+          </div>
+        </div>
+
+        <div class="row my-3">
+          <div class="col-6">
+            <h2>Request Token</h2>
+            <div class="card">
+              <div class="card-body">
+              The token can be obtained from the sdk or form
+              </div>
+            </div>
+            <h3>To get a token with a sdk</h3>
+            <div class="card">
+              <div class="card-body">
+                <pre>
+                <code>
+token = StudyplusForSchoolSync::Token.new(
+          base_url: base_url,
+          client_id: client_id,
+          client_secret: client_secret
+        )
+response = token.create(
+             authorization_code: "<%= code %>",
+             redirect_uri: redirect_uri
+            )
+                  </code>
+                </pre>
+              </div>
+            </div>
+            <h3>To get a token with a form</h3>
+            BASE_URL:
+            <% if ENV["BASE_URL"] %>
+              <%= ENV["BASE_URL"] %>
+            <% else %>
+            <p class="text-danger">Specify the environment variable to start!!</p>
+            <% end %>
+            <form action="<%= ENV["BASE_URL"]%>/learning_material_supplier_api/v1/oauth/token" method="post">
+              <div class="mb-3">
+                <label class="form-label">client_id: </label>
+                <input type="text" name="client_id" class="form-control">
+              </div>
+              <div class="mb-3">
+                <label class="form-label">client_secret: </label>
+                <input type="text" name="client_secret" class="form-control">
+              </div>
+              <div class="mb-3">
+                <label class="form-label">redirect_uri: </label>
+                <input type="text" name="redirect_uri" class="form-control">
+              </div>
+              <div class="mb-3">
+                <label class="form-label">grant_type: </label>
+                <input type="text" name="grant_type" value="authorization_code" class="form-control">
+              </div>
+              <div class="mb-3">
+                <label class="form-label">code: </label>
+                <input type="text" name="code" value="<%= code %>" class="form-control">
+              </div>
+
+              <input class="btn btn-primary" type="submit" value="Submit">
+            </form>
+          </div>
+        </div>
+      </div>
+    </body>
+</html>

data/lib/studyplus_for_school_sync/server.rb

@@ -0,0 +1,28 @@
+require "webrick"
+require "webrick/https"
+require "erb"
+
+module StudyplusForSchoolSync
+  class Server
+    def start(port: "8080")
+      root = File.expand_path("../html/index.erb", __FILE__)
+
+      server = WEBrick::HTTPServer.new(
+        Port: port,
+        DocumentRoot: ".",
+        SSLEnable: true,
+        SSLCertName: [["CN", WEBrick::Utils.getservername]],
+      )
+
+      WEBrick::HTTPServlet::FileHandler.add_handler("erb", WEBrick::HTTPServlet::ERBHandler)
+      server.config[:MimeTypes]["erb"] = "text/html"
+      server.mount_proc("/") { |req, res|
+        code = req.query["code"]
+        template = ERB.new(File.read(root))
+        res.body << template.result(binding)
+      }
+      trap "INT" do server.shutdown end
+      server.start
+    end
+  end
+end

data/lib/studyplus_for_school_sync/token.rb

@@ -0,0 +1,74 @@
+require "uri"
+require "json"
+require "faraday"
+require "faraday/encoding"
+require "faraday_middleware"
+
+module StudyplusForSchoolSync
+  # Handling access token
+  class Token
+    END_POINT = "/learning_material_supplier_api/v1/oauth/token"
+
+    attr_reader :base_url, :client_id, :client_secret, :grant_type
+
+    # @param base_url [String] API domain
+    # @param client_id [String] Application ClientID
+    # @param client_secret [String] Application Secret 
+    def initialize(base_url:, client_id:, client_secret:)
+      @base_url = base_url
+      @client_id = client_id
+      @client_secret = client_secret
+      @conn = Faraday.new(headers: default_header) do |connection|
+        connection.response :json
+        connection.response :encoding
+        connection.adapter Faraday.default_adapter
+      end
+    end
+ 
+    # Creating a token from authorization code
+    # @param authorization_code [String] Authorization Code
+    # @param redirect_uri [String] Application Redirect URI
+    def create(authorization_code:, redirect_uri:)
+      post(
+        path: END_POINT,
+        params: {
+          client_id: client_id,
+          client_secret: client_secret,
+          redirect_uri: redirect_uri,
+          grant_type: "authorization_code",
+          code: authorization_code,
+        }
+      )
+    end
+
+    # Refresh Token
+    # @param refresh_token [String] Refresh token obtained during token generation
+    def refresh(refresh_token)
+      post(
+        path: END_POINT,
+        params: {
+          client_id: client_id,
+          client_secret: client_secret,
+          grant_type: "refresh_token",
+          refresh_token: refresh_token,
+        }
+      )
+    end
+
+    private
+
+    def post(path:, params: nil)
+      @conn.post(build_url(path)) do |req|
+        req.body = params.to_json if params
+      end
+    end
+
+    def build_url(path)
+      URI.join(base_url, path)
+    end
+
+    def default_header
+      { "Accept" => "application/json", "Content-Type" => "application/json" }
+    end
+  end
+end

data/lib/studyplus_for_school_sync/version.rb

@@ -0,0 +1,3 @@
+module StudyplusForSchoolSync
+  VERSION = "0.1.0"
+end

data/studyplus_for_school_sync.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "studyplus_for_school_sync/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "studyplus_for_school_sync"
+  spec.version       = StudyplusForSchoolSync::VERSION
+  spec.authors       = ["shimada"]
+  spec.email         = ["shimada227@gmail.com"]
+
+  spec.summary       = "StudyplusForSchoolSync::Client - SDK of the Studyplus for School SYNC API for Ruby"
+  spec.description   = "SDK of the Studyplus for School SYNC API for Ruby"
+  spec.homepage      = "https://github.com/yshimada0330/studyplus_for_school_sync"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday-encoding"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "launchy"
+  spec.add_dependency "thor"
+  spec.add_dependency "webrick"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: studyplus_for_school_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shimada
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday-encoding
+  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: faraday_middleware
+  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: launchy
+  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: thor
+  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: webrick
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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: simplecov
+  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: SDK of the Studyplus for School SYNC API for Ruby
+email:
+- shimada227@gmail.com
+executables:
+- studyplus_for_school_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/studyplus_for_school_sync
+- lib/studyplus_for_school_sync.rb
+- lib/studyplus_for_school_sync/authorizer.rb
+- lib/studyplus_for_school_sync/cli.rb
+- lib/studyplus_for_school_sync/client.rb
+- lib/studyplus_for_school_sync/endpoint.rb
+- lib/studyplus_for_school_sync/endpoint/learning_material.rb
+- lib/studyplus_for_school_sync/endpoint/partner.rb
+- lib/studyplus_for_school_sync/endpoint/student.rb
+- lib/studyplus_for_school_sync/html/index.erb
+- lib/studyplus_for_school_sync/server.rb
+- lib/studyplus_for_school_sync/token.rb
+- lib/studyplus_for_school_sync/version.rb
+- studyplus_for_school_sync.gemspec
+homepage: https://github.com/yshimada0330/studyplus_for_school_sync
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: StudyplusForSchoolSync::Client - SDK of the Studyplus for School SYNC API
+  for Ruby
+test_files: []