ovh-api 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69d4f0ac19265bdc055a6fc8b695b1030a812d94
+  data.tar.gz: 621aff07a34b942b84a6c976c79e15b7f702ce76
+SHA512:
+  metadata.gz: d662f03a606e032984f0fbeaff90ac9a265f0627fd82351e67af2aabf89706163fb7affbd3d97356bcd557d5b32f295cf5eb18617f57a3bf058e42037b8baae5
+  data.tar.gz: ddc4902d6c3da93b2304518c0889b28977b88e188f4a5fdc27822fa83b9ed55794a29464c5d44d7a8637e520c21569be85f2c55e085056030ef5c8d207b557cf

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Roland Laurès / Semifir SAS
+
+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/lib/ovh-api.rb

@@ -0,0 +1,7 @@
+
+module OVHApi
+end
+
+require 'ovh-api/version'
+require 'ovh-api/exceptions'
+require 'ovh-api/client'

data/lib/ovh-api/client.rb

@@ -0,0 +1,136 @@
+require "net/https"
+require "uri"
+require 'json'
+require 'yaml'
+require 'digest/sha1'
+
+# Main module
+module OVHApi
+  # Main class
+  class Client
+
+    HOST = 'eu.api.ovh.com'
+    attr_reader :application_key, :application_secret, :consumer_key
+
+    def initialize(application_key: nil, application_secret: nil, consumer_key: nil)
+      begin
+        conf = YAML.load_file('config/ovh-api.yml')
+        @application_key    = application_key || conf['application_key']
+        @application_secret = application_secret || conf['application_secret']
+        @consumer_key       = consumer_key || conf['consumer_key']
+      rescue SystemCallError
+      end
+
+      @application_key    = application_key
+      @application_secret = application_secret
+      @consumer_key       = consumer_key
+
+      raise OVHApiNotConfiguredError.new(
+        "Either instantiate Client.new with application_key and application_secret, or create a YAML file in config/ovh-api.yml with those values set") if @application_key.nil? || @application_secret.nil?
+
+    end
+
+    # Request a consumer key
+    #
+    # @param [Hash] access_rules
+    # @return [Hash] the JSON response
+    def request_consumerkey(access_rules)
+      uri = ::URI.parse("https://#{HOST}")
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      headers = {
+        'X-Ovh-Application' => @application_key,
+        'Content-type'      => 'application/json'
+      }
+
+      resp = http.post('/1.0/auth/credential', access_rules.to_json, headers)
+      begin
+        body_hash = JSON.parse(resp.body)
+        @consumer_key = body_hash['consumerKey']
+
+        return resp, body_hash["validationUrl"]
+      rescue JSON::ParserError
+        return resp
+      end
+    end
+
+    # Generate signature
+    #
+    # @param url [String]
+    # @param method [String]
+    # @param timestamp [String]
+    # @param body [String]
+    #
+    def get_signature(url, method, timestamp, body = "")
+      signature = "$1$#{Digest::SHA1.hexdigest("#{application_secret}+#{consumer_key}+#{method}+https://#{HOST}/1.0#{url}+#{body}+#{timestamp}")}"
+      signature
+    end
+
+    # Make a get request to the OVH api
+    #
+    # @param url [String]
+    # @return [Net::HTTPResponse] response
+    def get(url)
+
+      request(url, 'GET', '')
+
+    end
+
+    # Make a post request to the OVH api
+    #
+    # @param url [String]
+    # @param body [String]
+    # @return [Net::HTTPResponse] response
+    def post(url, body)
+
+      request(url, 'POST', body)
+
+    end
+
+    # Make a put request to the OVH api
+    #
+    # @param url [String]
+    # @param body [String]
+    # @return [Net::HTTPResponse] response
+    def put(url, body)
+
+      request(url, 'PUT', body)
+    end
+
+
+    # Make a delete request to the OVH api
+    #
+    # @param url [String]
+    # @return [Net::HTTPResponse] response
+    def delete(url)
+
+      request(url, 'DELETE', '')
+
+    end
+
+    def request(url, method, body)
+
+      raise OVHApiNotConfiguredError.new(
+        "You cannot call Client#request without a consumer_key, please use the Client#request_consumerkey method to get one, and validate it with you credential by following the link, and/or save the consumer_key value in the YAML file in config/ovh-api.yml") if @consumer_key.nil?
+
+      uri = ::URI.parse("https://#{HOST}")
+      http = ::Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      timestamp = Time.now.to_i
+
+      headers = {
+        'Host'              => HOST,
+        'Accept'            => 'application/json',
+        'Content-Type'      => 'application/json',
+        'X-Ovh-Application' => application_key,
+        'X-Ovh-Timestamp'   => timestamp.to_s,
+        'X-Ovh-Signature'   => get_signature(url, method, timestamp.to_s, body),
+        'x-Ovh-Consumer'    => consumer_key
+      }
+
+      http.send_request(method, "/1.0#{url}", body, headers)
+    end
+  end
+end

data/lib/ovh-api/exceptions.rb

@@ -0,0 +1,4 @@
+module OVHApi
+  class OVHApiError < RuntimeError; end
+  class OVHApiNotConfiguredError < OVHApiError; end
+end

data/lib/ovh-api/version.rb

@@ -0,0 +1,3 @@
+module OVHApi
+  VERSION = '1.0.1'
+end

data/readme.md

@@ -0,0 +1,97 @@
+# Important note
+This is not an official repository of OVH and this is a work in progress
+
+Lightweight wrapper around OVH's APIs. Handles all the hard work including credential creation and requests signing.
+
+```ruby
+require_relative 'client'
+
+client = OVH::Client.new(
+  application_key: '<app key>',
+  application_secret: '<app secret>',
+  consumer_key: '<consumer key>'
+)
+
+puts client.get('/me').body['firstname']
+```
+
+# Installation
+For now you have to clone the repo and make a bundle.
+
+# Example usage
+
+### Use the API on behalf of a user
+
+1. Create an application
+
+  To interact with the APIs, the SDK needs to identify itself using an application_key and an application_secret. To get them, you need to register your application.
+  For now only the OVH Europe API is supported.
+    - [OVH Europe](https://eu.api.ovh.com/createApp/)
+
+  Once created, you will obtain an __application key (AK)__ and an __application secret (AS)__.
+
+2. Configure your application
+
+  The easiest and safest way to use your application's credentials is create a conf.yml configuration file in application's working directory. Here is how it looks like:
+  ```yaml
+  application_key: app_key
+  application_secret: app_secret
+  # consumer_key: consumer_key
+  ```
+
+3. Authorize your application to access a customer account
+
+  To allow your application to access a customer account using the API on your behalf, you need a __consumer key (CK)__.
+
+  Here is a sample code you can use to allow your application to access a customer's informations:
+
+```ruby
+require_relative 'client'
+# create a client using configuration
+client =  OVH::Client.new
+
+# Request RO, /me API access
+access_rules = {
+  accessRules: [
+    {'method' => 'GET', 'path' => '/me'}
+  ]
+}
+
+# Request token
+validation = JSON.parse(client.request_consumerkey(access_rules).body)
+
+puts "Please visit #{validation['validationUrl']}"
+puts "Then press Enter"
+gets
+
+puts "Welcome #{JSON.parse(client.get('/me').body)['firstname']}"
+puts "Btw, your consumerKey is #{validation['consumerKey']}"
+```
+
+  Returned __consumerKey__ should then be kept to avoid re-authenticating your end-user on each use.
+
+  To request full and unlimited access to the API, you may use wildcards:
+
+```ruby
+access_rules = [
+  {'method': 'GET', 'path': '/*'},
+  {'method': 'POST', 'path': '/*'},
+  {'method': 'PUT', 'path': '/*'},
+  {'method': 'DELETE', 'path': '/*'}
+]
+```
+
+# Run the tests
+For now the only test is a _Cucumber_ test (integration test).
+More tests will come (cucmber and Rspec)
+
+```
+cucumber
+```
+
+# Build the documentation
+Documentation is managed with _Yard_
+
+```
+yard
+```

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ovh-api
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Roland Laurès
+- Benoit Vasseur
+- Zyurs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: 'Library wrapping OVH API v6 (see: https://api.ovh.com)'
+email: roland.laures@semifir.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/ovh-api.rb
+- lib/ovh-api/client.rb
+- lib/ovh-api/exceptions.rb
+- lib/ovh-api/version.rb
+- readme.md
+homepage: https://github.com/ShamoX/ruby-ovh
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: OVH API v6 wrapper
+test_files: []