restfull_oauth 0.1.0

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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d07bc8ce524b6ff845ca7d4a2c14764df810a69f
4
+ data.tar.gz: b370b311fe27646786a0f3d39c3e3d841d051221
5
+ SHA512:
6
+ metadata.gz: 7bd1e9af73ba16c2090379a18308227a513f12240f13af1ecbf07c7064cc77a54172fa40a5f0a9feb748cc3ae170793858fa1a680c0960db3c84ceceed750f73
7
+ data.tar.gz: 85010fc80385afd99a30210c6b1251c93a1fe2b140b501c14ff456026de53cc21ce247ecb99f851e9ab5f4c8cd0db6a4b0dc662206c78fbfa94f375d622b87ba
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.2
4
+ before_install: gem install bundler -v 1.10.6
@@ -0,0 +1,13 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4
+
5
+ We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
6
+
7
+ Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
8
+
9
+ 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
10
+
11
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
12
+
13
+ This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in restfull_oauth.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Daniel.van.den.Oord
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.
@@ -0,0 +1,63 @@
1
+ # RestfullOauth
2
+
3
+ This Gem will enable you to communicate with any Restfull API secured by Oauth v1
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'restfull_oauth'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install restfull_oauth
20
+
21
+ ## Usage
22
+
23
+ You might first need to authenticate this app to your service by running the command
24
+ ```sh
25
+ % authenticate
26
+ ```
27
+
28
+ Use the above information to connect to the rest api after this you can do a get post put request.
29
+ GET request (get product information):
30
+
31
+ ```irb
32
+ % irb
33
+ >> keys = {"consumer_key"=>"your_consumer_key", "consumer_secret"=>"your_consumer_secret", "token"=>"your_token", "token_secret"=>"your_token_secret"}
34
+ >> json_response = RestfullOauth::connect('GET','https://your server/rest/api', keys)
35
+ => #<Net::HTTPOK 200 OK readbody=true>
36
+ ```
37
+
38
+ POST request (assign product to website):
39
+
40
+ ```irb
41
+ % irb
42
+ >> keys = {"consumer_key"=>"your_consumer_key", "consumer_secret"=>"your_consumer_secret", "token"=>"your_token", "token_secret"=>"your_token_secret"}
43
+ >> post_data = {'website_id' => 1 }.to_json
44
+ >> json_response = RestfullOauth::connect('POST','https://your server/rest/api', keys, post_data)
45
+ => #<Net::HTTPOK 200 OK readbody=true>
46
+ ```
47
+
48
+ PUT requests work in the same way as POST requests
49
+
50
+ ## Development
51
+
52
+ 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.
53
+
54
+ 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
55
+
56
+ ## Contributing
57
+
58
+ Bug reports and pull requests are welcome on GitHub at https://github.com/Daniel304/restfull_oauth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
59
+
60
+
61
+ ## License
62
+
63
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ #require "rspec/core/rake_task"
3
+
4
+ #RSpec::Core::RakeTask.new(:spec)
5
+
6
+ #task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "restfull_oauth"
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
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,94 @@
1
+ require "restfull_oauth/version"
2
+ require 'oauth'
3
+ require 'uri'
4
+ require 'cgi'
5
+ require 'openssl'
6
+ require 'base64'
7
+ require 'net/http'
8
+ require 'json'
9
+ require 'yaml'
10
+
11
+ module RestfullOauth
12
+ # This Gem will enable you to communicate to any restfull service using Oauth v1
13
+ #
14
+ # If you only have a consumer_token and consumer_secret then you might need to get a verifier code
15
+ # Use this command to get your app authenticated:
16
+ # % authenticate
17
+ #
18
+ # Example:
19
+ # % irb
20
+ # >> keys = {"consumer_key"=>"your_consumer_key", "consumer_secret"=>"your_consumer_secret", "token"=>"your_token", "token_secret"=>"your_token_secret"}
21
+ # >> json_response = RestfullOauth::connect('GET','https://your domain/restfull/api/', keys)
22
+ # => #<Net::HTTPOK 200 OK readbody=true>
23
+ # >> post_data = { "test" => "test" }.to_json
24
+ # >> json_response = RestfullOauth::connect('POST','https://your domain/restfull/api/', keys, post_data)
25
+ # => #<Net::HTTPOK 200 OK readbody=true>
26
+
27
+ def self.generate_nonce(size=6)
28
+ Base64.encode64(OpenSSL::Random.random_bytes(size)).gsub(/\W/, '')
29
+ end
30
+
31
+ def self.url_encode(string)
32
+ CGI::escape(string)
33
+ end
34
+
35
+ def self.params(consumer_key, token)
36
+ params = {
37
+ 'oauth_consumer_key' => consumer_key,
38
+ 'oauth_nonce' => generate_nonce,
39
+ 'oauth_signature_method' => 'HMAC-SHA1',
40
+ 'oauth_token' => token,
41
+ 'oauth_version' => '1.0',
42
+ 'oauth_timestamp' => Time.now.to_i.to_s
43
+ }
44
+ end
45
+
46
+ def self.signature_base_string(method, uri, params)
47
+ encoded_params = url_encode("oauth_consumer_key=#{params['oauth_consumer_key']}&oauth_nonce=#{params['oauth_nonce']}&oauth_signature_method=#{params['oauth_signature_method']}&oauth_timestamp=#{params['oauth_timestamp']}&oauth_token=#{params['oauth_token']}&oauth_version=#{params['oauth_version']}")
48
+ encoded = method + '&' + url_encode(uri) + '&' + encoded_params
49
+ end
50
+
51
+ def self.sign(key, base_string)
52
+ digest = OpenSSL::Digest.new('sha1')
53
+ hmac = OpenSSL::HMAC.digest(digest, key, base_string)
54
+ Base64.encode64(hmac).chomp.gsub(/\n/, '')
55
+ end
56
+
57
+ def self.create_header(params)
58
+ header = "OAuth "
59
+ params.each do |k, v|
60
+ header += "#{k}=\"#{v}\","
61
+ end
62
+ header.slice(0..-2)
63
+ end
64
+
65
+ def self.request_data(header, uri, method, post_data=nil)
66
+ uri = URI(uri)
67
+ http = Net::HTTP.new(uri.host, uri.port)
68
+ http.use_ssl = true
69
+ http.verify_mode = OpenSSL::SSL::VERIFY_NONE
70
+ if method == 'POST'
71
+ resp, data = http.post(uri.path, post_data, { 'Authorization' => header, "Content-Type" => "application/json; charset=utf-8" })
72
+ elsif method == 'PUT'
73
+ request = Net::HTTP::Put.new(uri.path)
74
+ headers = { 'Authorization' => header, "Content-Type" => "application/json" }
75
+ headers.keys.each do |key|
76
+ request[key] = headers[key]
77
+ end
78
+ request.body = post_data
79
+ resp, data = http.request(request)
80
+ else
81
+ resp, data = http.get(uri.path, { 'Authorization' => header, "Content-Type" => "application/json; charset=utf-8" })
82
+ end
83
+ resp
84
+ end
85
+
86
+ def self.connect(method, uri, keys, post_data=nil)
87
+ params = params(keys['consumer_key'], keys['token'] )
88
+ signature_base_string = signature_base_string(method, uri.to_s, params)
89
+ signing_key = keys['consumer_secret'] + '&' + keys['token_secret']
90
+ params['oauth_signature'] = url_encode(sign(signing_key, signature_base_string))
91
+ header_string = create_header(params)
92
+ json_response = request_data(header_string, uri, method, post_data)
93
+ end
94
+ end
@@ -0,0 +1,3 @@
1
+ module RestfullOauth
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,32 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'restfull_oauth/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "restfull_oauth"
8
+ spec.version = RestfullOauth::VERSION
9
+ spec.authors = ["Daniel.van.den.Oord"]
10
+ spec.email = ["daniel304@chello.nl"]
11
+
12
+ spec.summary = "Ruby Oauth restfull api GET, PUT, POST"
13
+ spec.description = "This Api works with Oauth v1 restfull Apis it supports GET,PUT,POST http requests"
14
+ spec.homepage = "https://github.com/Daniel304/restfull_oauth"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
18
+ # delete this section to allow pushing this gem to any host.
19
+ if spec.respond_to?(:metadata)
20
+ spec.metadata['allowed_push_host'] = "https://rubygems.org"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+
30
+ spec.add_development_dependency "bundler", "~> 1.10"
31
+ spec.add_development_dependency "rake", "~> 10.0"
32
+ end
metadata ADDED
@@ -0,0 +1,87 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: restfull_oauth
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Daniel.van.den.Oord
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2016-12-13 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.10'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.10'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ description: This Api works with Oauth v1 restfull Apis it supports GET,PUT,POST http
42
+ requests
43
+ email:
44
+ - daniel304@chello.nl
45
+ executables: []
46
+ extensions: []
47
+ extra_rdoc_files: []
48
+ files:
49
+ - ".gitignore"
50
+ - ".rspec"
51
+ - ".travis.yml"
52
+ - CODE_OF_CONDUCT.md
53
+ - Gemfile
54
+ - LICENSE.txt
55
+ - README.md
56
+ - Rakefile
57
+ - bin/console
58
+ - bin/setup
59
+ - lib/restfull_oauth.rb
60
+ - lib/restfull_oauth/version.rb
61
+ - restfull_oauth.gemspec
62
+ homepage: https://github.com/Daniel304/restfull_oauth
63
+ licenses:
64
+ - MIT
65
+ metadata:
66
+ allowed_push_host: https://rubygems.org
67
+ post_install_message:
68
+ rdoc_options: []
69
+ require_paths:
70
+ - lib
71
+ required_ruby_version: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ required_rubygems_version: !ruby/object:Gem::Requirement
77
+ requirements:
78
+ - - ">="
79
+ - !ruby/object:Gem::Version
80
+ version: '0'
81
+ requirements: []
82
+ rubyforge_project:
83
+ rubygems_version: 2.4.8
84
+ signing_key:
85
+ specification_version: 4
86
+ summary: Ruby Oauth restfull api GET, PUT, POST
87
+ test_files: []