msidp-endpoint 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9217f4c3e53be7d57aea0a021671939445d7abe2aeac645948935900b8a289
-  data.tar.gz: 01f12f461ef866dbd079c15fc504973d0aa83795e9ecf4d763bf5d3d758d4866
+  metadata.gz: 1c3063389a5690ccaabdb90a88d5b829e4d679c75535e557abcd2894b5b7423e
+  data.tar.gz: 496d1e0b37bd567c2c955f716360e451b8ce768454095a3746364a423c1ee2ec
 SHA512:
-  metadata.gz: 42f07a9e6127d52203e646df3fc071e9e88ee9be8436eb04118762cc0756678a9d1918f56bb179dbd73a5d23c724a9139d27a1bf6b681cefe8633cbc791b88cf
-  data.tar.gz: 7a5e4fd84a032765c5bf05556e08e43d3f63a29cce450d09343cb64aaeb11b2bbcc412f221541f55944a09a69e11be27d2c47086bc62b425398367e69bca3933
+  metadata.gz: 7f70b2959ca814ec3d3c967b46183b5f79d3c9ccf642a30929b741d6321f22da91b918b5937ec943086c94cf8647108916b515674c44e27213d35d6cf3f9d93b
+  data.tar.gz: c6f5d2f9e19039707aad84c62f7b863d4b93b2c03ea21a4a4208ec6571ecddd825b8659eccec51aff3b7ad137b3357b9e2f49dd641781bf96318679175737897

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+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,88 @@
+# MSIDP::Endpoint
+
+[![Gem Version](https://badge.fury.io/rb/msidp-endpoint.svg)](https://badge.fury.io/rb/msidp-endpoint)
+![Ruby](https://github.com/simayosi/rb-msidp-endpoint/actions/workflows/test.yml/badge.svg)
+
+
+A simple library for authentication endpoints of Microsoft identity platform.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'msidp-endpoint'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install msidp-endpoint
+
+
+## Getting started
+
+### Preparation
+
+Register your application.
+See MS documents for details.
+
+### Usage example
+Client using OAuth 2.0 authorization code grant.
+```ruby
+require 'msidp/endpoint'
+
+class Client
+  include MSIDP::Endpoint
+
+  def initialize
+    @tenant = 'tentant.example.com'
+    @auth_uri = authorize_uri(tenant)
+    @token_uri = token_uri(tenant)
+    @client_id = 'CLIENT-ID'
+    @client_secret = 'CLIENT-SECRET'
+    @redirect_uri = 'http://localhost/'
+    @scope = 'https://graph.microsoft.com/.default'
+  end
+
+  def access_authorize_page
+    params = {
+      client_id: @client_id, response_type: 'code',
+      redirect_uri: @redirect_uri, scope: @scope,
+    }
+    authorize(@auth_uri, params)
+  end
+
+  def get_token(code)
+    @params = {
+      code: code, client_id: @client_id, redirect_uri: @redirect_uri,
+      grant_type: 'authorization_code', client_secret: @client_secret
+    }
+    call_token(@uri, @params)
+  end
+end
+
+client = Client.new
+response = client.access_authorize_page
+# Get the code parameter of the query in the callback somehow.
+token = client.get_token(code)
+
+if token.valid? in: 3
+  auth_header = { 'Authorization' => "Bearer #{token}" }
+
+  # Request to a resource with the auth_header.
+end
+```
+
+
+## API Reference
+[RubyDoc.info](https://rubydoc.info/gems/msidp-endpoint)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/msidp/endpoint/version.rb

@@ -2,6 +2,6 @@
 
 module MSIDP
   module Endpoint
-    VERSION = '0.0.1'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msidp-endpoint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - SHIMAYOSHI, Takao
@@ -17,6 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/msidp/access_token.rb
 - lib/msidp/endpoint.rb
 - lib/msidp/endpoint/version.rb
@@ -30,6 +32,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/simayosi/rb-msidp-endpoint
   source_code_uri: https://github.com/simayosi/rb-msidp-endpoint
+  documentation_uri: https://rubydoc.info/gems/msidp-endpoint
 post_install_message: 
 rdoc_options: []
 require_paths: