ovh-rest 0.0.1 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bc0866dbac656dfdf22eef5798d5a766d094092
+  data.tar.gz: 392e592fcff25c5c6466465581c2911b2a2b170b
+SHA512:
+  metadata.gz: 797fd218c4791c34ade0995487b001e90bb8ceca720bae003097f4c077a3a6ea155efdaf0c3e49d0aa08ef2a4fb7083d9c7c254b3cdadb9019b56dac195bd3cf
+  data.tar.gz: 3f18825c1bbc9366249ac03e25575b39c5bbb822f47e1db7e0003f36c4b4386de12a21e3249a08849272f927cc8c3e5a6b8a8254e698be38bcf349e56b6e5bc2

data/README.md

@@ -0,0 +1,107 @@
+# OVH-REST
+
+OVH-REST is a (really) tiny, unofficial helper library OVH management [API](https://api.ovh.com/console/), wrapping the authentication parts and simplifying interaction in Ruby programs.
+
+You need an `appKey` and an `appSecret` to use it, which can be obtained [there](https://www.ovh.com/fr/cgi-bin/api/createApplication.cgi).
+
+## Usage
+
+First, you need to generate a `consumerKey` which is grants access to specific methods and parts of the API.
+
+```ruby
+require 'ovh/rest'
+
+access = {
+  "accessRules" => [
+    { "method" => "GET", "path" => "/sms/*" },
+    { "method" => "POST", "path" => "/sms/*" },
+    { "method" => "PUT", "path" => "/sms/*" },
+    { "method" => "DELETE", "path" => "/sms/*" },
+  ]
+}
+
+OVH::REST.generate_consumer_key("your_appKey", access)
+=> {
+  "validationUrl" => "https://www.ovh.com/fr/cgi-bin/api/requestCredential.cgi?credentialToken=XXXXXXXXXXXXXXXXXXXXXXX",
+  "consumerKey" => "ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ",
+  "state" => "pendingValidation"
+}
+
+```
+
+You now have your `consumerKey`, which needs validation before use. Validation is done by following the `validationUrl` and entering your credentials.
+
+Then you can use API features:
+
+```ruby
+require 'ovh/rest'
+
+ovh = OVH::REST.new(apiKey, appSecret, consumerKey)
+
+# Get sms account status
+result = ovh.get("/sms/sms-xx12345-1")
+
+puts JSON.pretty_generate(result)
+=>
+{
+  "status": "enable",
+  "creditsLeft": 42,
+  "name": "sms-xx12345-1",
+  "userQuantityWithQuota": 0,
+  "description": "",
+[...]
+}
+
+# Send sms
+result = ovh.post("/sms/sms-xx12345-1/jobs", {
+  "charset" => "UTF-8",
+  "class" => "phoneDisplay",
+  "coding" => "7bit",
+  "priority" => "high",
+  "validityPeriod" => 2880
+  "message" => "Dude! Disk is CRITICAL!",
+  "receivers" => ["+12345678900", "+12009876543"],
+  "sender" => "+12424242424",
+})
+
+puts JSON.pretty_generate(result)
+=>
+{
+  "totalCreditsRemoved": 2,
+  "ids": [
+    12345,
+    12346
+  ]
+}
+```
+
+All methods and parameters are described on the API documentation
+
+## Change API URL
+
+It's possible to change the API url according to where your OVH account is located. To change the API url for generate_consumer_key use something like this:
+
+```ruby
+OVH::REST.generate_consumer_key("your_appKey", access, 'https://ca.api.ovh.com/1.0')
+```
+
+Or, for calling other methods:
+
+```ruby
+ovh = OVH::REST.new(apiKey, appSecret, consumerKey, 'https://ca.api.ovh.com/1.0')
+```
+
+## Setup
+
+Only tested with MRI >= 1.9.3
+
+Dependencies: none
+
+Install:
+ * git clone https://github.com/Fotolia/ovh-rest
+OR
+ * gem install ovh-rest
+
+## Links
+
+Introduction, in french: http://www.ovh.com/fr/g934.premiers-pas-avec-l-api

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/ovh.rb

@@ -1,3 +1,2 @@
 module OVH
-  VERSION = "0.0.1"
 end

data/lib/ovh/rest.rb

@@ -9,22 +9,33 @@ module OVH
   class RESTError < StandardError; end
 
   class REST
-    API_URL = "https://api.ovh.com/1.0"
+    DEFAULT_API_URL = "https://api.ovh.com/1.0"
+
+    attr_accessor :api_url
 
     class << self
-      def generate_consumer_key(api_key, access_rules)
-        uri = URI.parse("#{API_URL}/auth/credential")
+      def generate_consumer_key(api_key, access_rules, api_url = nil)
+        uri = URI.parse("#{api_url || DEFAULT_API_URL}/auth/credential")
         request = Net::HTTP::Post.new(uri.path, initheader = {"X-Ovh-Application" => api_key, "Content-type" => "application/json"})
         request.body = access_rules.to_json
-        http = Net::HTTP.new(uri.host, uri.port)
+        http = build_http_object(uri.host, uri.port)
         http.use_ssl = true
         response = http.request(request)
         JSON.parse(response.body)
       end
+
+      def build_http_object(host, port)
+        if ENV['https_proxy']
+          proxy = URI.parse(ENV['https_proxy'])
+          Net::HTTP::Proxy(proxy.host, proxy.port).new(host, port)
+        else
+          Net::HTTP.new(host, port)
+        end
+      end
     end
 
-    def initialize(api_key, api_secret, consumer_key)
-      @api_url = API_URL
+    def initialize(api_key, api_secret, consumer_key, api_url = nil)
+      @api_url = api_url || DEFAULT_API_URL
       @api_key, @api_secret, @consumer_key = api_key, api_secret, consumer_key
     end
 
@@ -43,7 +54,7 @@ module OVH
         request = Net::HTTP.const_get(method.capitalize).new(uri.path, initheader = headers)
         request.body = body
 
-        http = Net::HTTP.new(uri.host, uri.port)
+        http = REST.build_http_object(uri.host, uri.port)
         http.use_ssl = true
         response = http.request(request)
         result = JSON.parse(response.body)

data/ovh-rest.gemspec

@@ -1,11 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ovh'
-
 Gem::Specification.new do |spec|
   spec.name          = "ovh-rest"
-  spec.version       = OVH::VERSION
+  spec.version       = "0.0.3"
   spec.authors       = ["Jonathan Amiez"]
   spec.email         = ["jonathan.amiez@fotolia.com"]
   spec.description   = "OVH REST API interface"

data/test/test_api_url.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+class TestApiUrl < Test::Unit::TestCase
+  def test_default_api_url
+    ovh = OVH::REST.new('api_key', 'api_secret', 'consumer_key')
+    assert_equal ovh.api_url, 'https://api.ovh.com/1.0'
+  end
+
+  def test_api_url_change
+    ca_api = 'https://ca.api.ovh.com/1.0'
+
+    ovh = OVH::REST.new('api_key', 'api_secret', 'consumer_key', ca_api)
+    assert_equal ovh.api_url, ca_api
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'ovh/rest'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ovh-rest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Jonathan Amiez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2014-06-09 00:00:00.000000000 Z
 dependencies: []
 description: OVH REST API interface
 email:
@@ -18,32 +17,37 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
 - lib/ovh.rb
 - lib/ovh/rest.rb
 - ovh-rest.gemspec
+- test/test_api_url.rb
+- test/test_helper.rb
 homepage: https://github.com/Fotolia/ovh-rest
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Manage OVH services from Ruby
-test_files: []
+test_files:
+- test/test_api_url.rb
+- test/test_helper.rb