misoca_ruby_client 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +7 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +5 -0
- data/LICENSE.txt +21 -0
- data/README.md +73 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/misoca_ruby_client/client.rb +37 -0
- data/lib/misoca_ruby_client/version.rb +3 -0
- data/lib/misoca_ruby_client.rb +5 -0
- data/misoca_ruby_client.gemspec +26 -0
- metadata +114 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 3cc7cfa222e16a85930d9cd252efae86d9e8f306
|
4
|
+
data.tar.gz: 8564097519208db3f7171a84791e1ec3ab8dfe33
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 93c21ffe520269f455ca3ad6967b31e820203a66f8081fcbdc00ef1fa038d38ce9e8ef5fa8c0ffb684a232741a0a48ea4cb9988dce4f7e57bf426de5afc433c0
|
7
|
+
data.tar.gz: 3301d0ff4277bb7af3e03f32e04ef67eef95eaf7afce21feda31d9634d486ef5e4d33731d612de474cc672349c199b24e53c244dd87ae06d3e70b71ec7b8c41d
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at hokichaio@hotmail.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Kevin Tsai
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
# MisocaRubyClient [](https://travis-ci.org/hokichaio/misoca_ruby_client)
|
2
|
+
|
3
|
+
## Installation
|
4
|
+
|
5
|
+
Add this line to your application's Gemfile:
|
6
|
+
|
7
|
+
```ruby
|
8
|
+
gem 'misoca_ruby_client'
|
9
|
+
```
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install misoca_ruby_client
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
Because misoca's refresh token live quite a long time. You can save your token somewhere and constantly refresh the token(e.g. Cron) so you don't have to do oath everytime.
|
22
|
+
```
|
23
|
+
# Create a proc so that we can save the token to somewhere
|
24
|
+
update_config = Proc.new { |access_token|
|
25
|
+
SomeModelToSaveToken.update_columns(misoca_access_token: access_token.token, misoca_refresh_token: access_token.refresh_token)
|
26
|
+
}
|
27
|
+
# Initialize client
|
28
|
+
mymisoca = MisocaRubyClient.new(application_id, secret, callback_url, update_config)
|
29
|
+
# Inject a saved token so that you can skip authentication
|
30
|
+
mymisoca.inject_access_token(misoca_access_token, misoca_refresh_token) if misoca_access_token && misoca_refresh_token
|
31
|
+
```
|
32
|
+
Then you can have a cron which do
|
33
|
+
```
|
34
|
+
mymisoca.refresh_access_token
|
35
|
+
```
|
36
|
+
at least once everyday.
|
37
|
+
|
38
|
+
You can also choose not using `update_config`. For this, you need a callback controller which do.
|
39
|
+
```
|
40
|
+
class OauthController < ApplicationController
|
41
|
+
def misoca_authorization
|
42
|
+
return redirect_to mymisoca.get_authorize_url
|
43
|
+
end
|
44
|
+
def misoca_callback
|
45
|
+
mymisoca.exchange_token(params[:code])
|
46
|
+
return redirect_to "/configs"
|
47
|
+
end
|
48
|
+
end
|
49
|
+
```
|
50
|
+
Note that `misoca_authorization` redirect you to Misoca's oauth page. `misoca_callback` is the callback which receive `params[:code]` and update access token.
|
51
|
+
|
52
|
+
Create an invoice
|
53
|
+
```
|
54
|
+
invoice = {
|
55
|
+
issue_date: Date.today,
|
56
|
+
payment_due_on: Date.today,
|
57
|
+
subject: "Pay Me Money",
|
58
|
+
recipient_name: "You"
|
59
|
+
recipient_title: 'Mr.',
|
60
|
+
invoice_body_attributes: {
|
61
|
+
recipient_zip_code: "123-4567",
|
62
|
+
recipient_address1: "My Address",
|
63
|
+
recipient_name1: "Someone",
|
64
|
+
recipient_title: 'Chief',
|
65
|
+
},
|
66
|
+
invoice_items_attributes: [{
|
67
|
+
name: "work",
|
68
|
+
quantity: 1,
|
69
|
+
unit_price: 100,
|
70
|
+
}]
|
71
|
+
}
|
72
|
+
mymisoca.access_token.post('/api/v1/invoice', { body: { invoice: invoice } })
|
73
|
+
```
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "misoca_ruby_client"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
module MisocaRubyClient
|
2
|
+
require 'oauth2'
|
3
|
+
class Client
|
4
|
+
MISOCA_END_POINT='https://app.misoca.jp/api/v1/'
|
5
|
+
MISOCA_AUTHORIZE_URI='https://app.misoca.jp/oauth2/authorize'
|
6
|
+
MISOCA_TOKEN_URI='https://app.misoca.jp/oauth2/token'
|
7
|
+
|
8
|
+
attr_reader :access_token
|
9
|
+
|
10
|
+
def initialize(application_id, secret, callback_url, config_block = nil)
|
11
|
+
@application_id = application_id
|
12
|
+
@secret = secret
|
13
|
+
@client = OAuth2::Client.new(@application_id, @secret, site: MISOCA_END_POINT, authorize_url: MISOCA_AUTHORIZE_URI, token_url: MISOCA_TOKEN_URI)
|
14
|
+
@callback_url = callback_url
|
15
|
+
@config_block = config_block
|
16
|
+
@access_token = nil
|
17
|
+
end
|
18
|
+
|
19
|
+
def get_authorize_url
|
20
|
+
return @client.auth_code.authorize_url(:redirect_uri => @callback_url, scope: 'write')
|
21
|
+
end
|
22
|
+
|
23
|
+
def exchange_token(code)
|
24
|
+
@access_token = @client.auth_code.get_token(code, :redirect_uri => @callback_url)
|
25
|
+
@config_block.call(@access_token) if @config_block
|
26
|
+
end
|
27
|
+
|
28
|
+
def refresh_access_token
|
29
|
+
@access_token = @access_token.refresh!
|
30
|
+
@config_block.call(@access_token) if @config_block
|
31
|
+
end
|
32
|
+
|
33
|
+
def inject_access_token(access_token, refresh_token)
|
34
|
+
@access_token = OAuth2::AccessToken.new(@client, access_token, refresh_token: refresh_token)
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'misoca_ruby_client/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "misoca_ruby_client"
|
8
|
+
spec.version = MisocaRubyClient::VERSION
|
9
|
+
spec.authors = ["Kevin Tsai"]
|
10
|
+
spec.email = ["hokichaio@hotmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{A client lib for Misoca.}
|
13
|
+
spec.description = %q{This client lib allow you to save/inject access token.}
|
14
|
+
spec.homepage = "https://github.com/hokichaio/misoca-ruby-client."
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_dependency "oauth2", "~> 1.1.0"
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.11"
|
24
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
25
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,114 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: misoca_ruby_client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kevin Tsai
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-06-22 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: oauth2
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 1.1.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 1.1.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.11'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.11'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rspec
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.0'
|
69
|
+
description: This client lib allow you to save/inject access token.
|
70
|
+
email:
|
71
|
+
- hokichaio@hotmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- CODE_OF_CONDUCT.md
|
80
|
+
- Gemfile
|
81
|
+
- LICENSE.txt
|
82
|
+
- README.md
|
83
|
+
- Rakefile
|
84
|
+
- bin/console
|
85
|
+
- bin/setup
|
86
|
+
- lib/misoca_ruby_client.rb
|
87
|
+
- lib/misoca_ruby_client/client.rb
|
88
|
+
- lib/misoca_ruby_client/version.rb
|
89
|
+
- misoca_ruby_client.gemspec
|
90
|
+
homepage: https://github.com/hokichaio/misoca-ruby-client.
|
91
|
+
licenses:
|
92
|
+
- MIT
|
93
|
+
metadata: {}
|
94
|
+
post_install_message:
|
95
|
+
rdoc_options: []
|
96
|
+
require_paths:
|
97
|
+
- lib
|
98
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0'
|
103
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
104
|
+
requirements:
|
105
|
+
- - ">="
|
106
|
+
- !ruby/object:Gem::Version
|
107
|
+
version: '0'
|
108
|
+
requirements: []
|
109
|
+
rubyforge_project:
|
110
|
+
rubygems_version: 2.5.1
|
111
|
+
signing_key:
|
112
|
+
specification_version: 4
|
113
|
+
summary: A client lib for Misoca.
|
114
|
+
test_files: []
|