scaleway 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17eaafe4fbff0675f6f549a688564fd44a158942
-  data.tar.gz: 4d1ad581a69b3f19ad0e9f6e3c4e499cf6e175df
+  metadata.gz: 24bc58f3cf0038fb5cf63a6d9de5dbe3b1eee4a3
+  data.tar.gz: 61c3fcbf49df0ae41a4113600113b0b30cfc81d2
 SHA512:
-  metadata.gz: 04263f1c48e43c50cb883451d520c1a1e225e3ad60defb836501f19e3b4cd60bdae7f42991e26a2a529c068a1a36cd01ed997186c9d13ba2635a03f89be34410
-  data.tar.gz: e590b54ea412e5df6f2ccfcf12686e352b65773671c1dcb6ff27e4780e80cd5d5642656ad42d2a548eab01940581dd71a779b789d7835d4d59cc133f5f1c47cc
+  metadata.gz: 6fd8343dace6d35e24bd6afdd7c8a9fb6cffe5896deeca8ece2263332b4e695df4fbb82b2d05dc8ddfd93defdefa8cb449feade37a6ca7986bd7a5a91a63e170
+  data.tar.gz: 920b2215110df212c56b47f01b282ef5099ce1499fed489efa23dbbac937dff2a9559080a58d136161a7f4dcc8902c69eb0dc5dd914363e27392cd13739c68d5

data/CHANGES.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## 1.0.0 (2016-10-31)
+
+- Add explicit error on missing authentication.
+- Add zone option.
+- Update default commercial type to VC1S.
+- Add marketplace API.
+
 ## 0.2.1 (2015-04-32)
 
 - Fix unittests.

data/README.md

@@ -9,171 +9,206 @@ Easy to use Scaleway api client.
 
 Manual instalation:
 
-	gem install scaleway
+```bash
+gem install scaleway
+```
 
 add this to your gemfile:
 
-	gem 'scaleway'
-
+```bash
+gem 'scaleway'
+```
 
 ## Usage
 
 ### Configure the client
 
-    require 'scaleway'
+```ruby
+require 'scaleway'
+
+Scaleway.organization = <organization_key>
+Scaleway.token = <token>
 
-	Scaleway.organization = <organization_key>
-	Scaleway.token = <token>
+# You can specify the zone, the default zone is 'par1'
+Scaleway.zone = 'ams1'
+```
 
 ### Servers
 
-	# list all servers
-	Scaleway::Server.all
+```ruby
+# list all servers
+Scaleway::Server.all
 
-	# list with filter
-	Scaleway::Server.all state: :running
+# list with filter
+Scaleway::Server.all state: :running
 
-	# create a new server with default values
-	Scaleway::Server.create
+# create a new server with default values
+Scaleway::Server.create
 
-	# create a new server with name and tags
-	Scaleway::Server.create :name => 'my_new_server', tags: ['prod']
+# create a new server with name and tags
+Scaleway::Server.create :name => 'my_new_server', tags: ['prod']
 
-	# get a server by id
-    server = Scaleway::Server.find <server_id>
+# get a server by id
+server = Scaleway::Server.find <server_id>
 
-	# edit a server
-    server = Scaleway::Server.find <server_id>
-	server.name = 'new_name'
-	Scaleway::Server.edit server.id, server
+# edit a server
+server = Scaleway::Server.find <server_id>
+server.name = 'new_name'
+Scaleway::Server.edit server.id, server
 
-	# actions on a server
-	Scaleway::Server.power_on server.id
+# actions on a server
+Scaleway::Server.power_on server.id
 
-	Scaleway::Server.power_off server.id
+Scaleway::Server.power_off server.id
 
-	Scaleway::Server.terminate server.id
+Scaleway::Server.terminate server.id
 
-	# destroy a server
-	Scaleway::Server.destroy server.id
+# destroy a server
+Scaleway::Server.destroy server.id
+```
 
-### Images
+### Marketplace
 
-	# list all images
-	Scaleway::Image.all
+```ruby
+# list all marketplace images
+Scaleway::Marketplace.all
 
-	# list marketplace images
-	Scaleway::Image.marketplace
+# get local image by id
+image = Scaleway::Marketplace.find_local_image <marketplace_image_id>
 
-	# get image by id
-	image = Scaleway::Image.find <image_id>
+# get local image by marketplace image id for arch arm
+image = Scaleway::Marketplace.find_local_image <marketplace_image_id>, arch: 'arm'
 
-	# get image by name
-	image = Scaleway::Image.find_by_name('Ubuntu')
+# get local image by name
+image = Scaleway::Marketplace.find_local_image_by_name("Docker")
+```
+
+### Images
 
-	# create an image
-	image = Scaleway::Image.create root_volume: snapshot
+```ruby
+# list all images
+Scaleway::Image.all
 
-	# edit an image
-	image = Scaleway::Image.edit id, image
+# get image by id
+image = Scaleway::Image.find <image_id>
 
-	# destroy an image
-	image = Scaleway::Image.destroy id
+# get image by name
+image = Scaleway::Image.find_by_name('Ubuntu')
+
+# create an image
+image = Scaleway::Image.create root_volume: snapshot
+
+# edit an image
+image = Scaleway::Image.edit id, image
+
+# destroy an image
+image = Scaleway::Image.destroy id
+```
 
 ### Volumes
 
-	# list all volumes
-	Scaleway::Volume.all
+```ruby
+# list all volumes
+Scaleway::Volume.all
 
-	# get volume by id
-	volume = Scaleway::Volume.find <volume_id>
+# get volume by id
+volume = Scaleway::Volume.find <volume_id>
 
-	# create an volume
-	volume = Scaleway::Volume.create
-	volume = Scaleway::Volume.create size: 100 * 10 ** 9, volume_type: 'l_ssd'
+# create an volume
+volume = Scaleway::Volume.create
+volume = Scaleway::Volume.create size: 100 * 10 ** 9, volume_type: 'l_ssd'
 
-	# edit an volume
-	volume = Scaleway::Volume.edit id, volume
+# edit an volume
+volume = Scaleway::Volume.edit id, volume
 
-	# destroy an volume
-	volume = Scaleway::Volume.destroy id
+# destroy an volume
+volume = Scaleway::Volume.destroy id
+```
 
 ### Snapshots
 
-	# list all snapshots
-	Scaleway::Volume.all
+```ruby
+# list all snapshots
+Scaleway::Volume.all
 
-	# get snapshot by id
-	snapshot = Scaleway::Snapshot.find <snapshot_id>
+# get snapshot by id
+snapshot = Scaleway::Snapshot.find <snapshot_id>
 
-	# create an snapshot
-	snapshot = Scaleway::Snapshot.create volume_id: id
+# create an snapshot
+snapshot = Scaleway::Snapshot.create volume_id: id
 
-	# edit an snapshot
-	snapshot = Scaleway::Snapshot.edit id, snapshot
+# edit an snapshot
+snapshot = Scaleway::Snapshot.edit id, snapshot
 
-	# destroy an snapshot
-	snapshot = Scaleway::Snapshot.destroy id
+# destroy an snapshot
+snapshot = Scaleway::Snapshot.destroy id
+```
 
 ### Ip addresses
 
-	# list all ip addresses
-	Scaleway::Ip.all
+```ruby
+# list all ip addresses
+Scaleway::Ip.all
 
-	# get Ip
-	ip = Scaleway::Ip.find <ip_id>
-	ip = Scaleway::Ip.find 127.0.0.1
+# get Ip
+ip = Scaleway::Ip.find <ip_id>
+ip = Scaleway::Ip.find 127.0.0.1
 
-	# reserve an ip
-	ip = Scaleway::Ip.reserve
-	# or
-	ip = Scaleway::Ip.create
+# reserve an ip
+ip = Scaleway::Ip.reserve
+# or
+ip = Scaleway::Ip.create
 
-	# edit an ip
-	ip = Scaleway::Ip.edit id, ip
+# edit an ip
+ip = Scaleway::Ip.edit id, ip
 
-	# release an ip
-	ip = Scaleway::Ip.destroy id
+# release an ip
+ip = Scaleway::Ip.destroy id
+```
 
 ### Handle exceptions
 
-	# Not found
-	begin
-		puts Scaleway::Server.find <invalid_id>
-	rescue Scaleway::NotFound => e
-		# handle error here
-	end
-
-	# Other
-	begin
-		puts Scaleway::Server.create extra_field: ['nope']
-	rescue Scaleway::APIError => e
-		# handle error here
-	end
+```ruby
+# Not found
+begin
+	puts Scaleway::Server.find <invalid_id>
+rescue Scaleway::NotFound => e
+	# handle error here
+end
+
+# Other
+begin
+	puts Scaleway::Server.create extra_field: ['nope']
+rescue Scaleway::APIError => e
+	# handle error here
+end
+```
 
 ## Example
 
-    require 'scaleway'
+```ruby
+require 'scaleway'
 
-	Scaleway.organization = <organization_key>
-	Scaleway.token = <token>
+Scaleway.organization = <organization_key>
+Scaleway.token = <token>
 
-	# get the docker image
-	image = Scaleway::Image.find_by_name('Docker')
+# get the docker image from the marketplace
+image = Scaleway::Marketplace.find_local_image_by_name('Docker')
 
-	# create 5 new servers
-	5.times do |x|
-		Scaleway::Server.create name: "docker#{x}", image: image.id, tags: ['docker']
-	end
+# create 5 new servers
+5.times do |x|
+	Scaleway::Server.create name: "docker#{x}", image: image.id, tags: ['docker']
+end
 
-	# power on
-	Scaleway::Server.all.each do |server|
-		Scaleway::Server.power_on(server.id)
-	end
+# power on
+Scaleway::Server.all.each do |server|
+	Scaleway::Server.power_on(server.id)
+end
 
-	# do something ...
+# do something ...
 
-	# terminate
-	Scaleway::Server.all.each do |server|
-		Scaleway::Server.terminate(server.id)
-	end
+# terminate
+Scaleway::Server.all.each do |server|
+	Scaleway::Server.terminate(server.id)
+end
+```

data/lib/scaleway.rb

@@ -8,13 +8,26 @@ module Scaleway
   extend self
 
   def compute_endpoint
-    "https://api.scaleway.com"
+    "https://cp-#{Scaleway.zone}.scaleway.com"
   end
 
   def account_endpoint
     "https://account.scaleway.com"
   end
 
+  def marketplace_endpoint
+    "https://api-marketplace.scaleway.com"
+  end
+
+  def zone=(zone)
+    @zone = zone
+    @zone
+  end
+
+  def zone
+    return @zone || 'par1'
+  end
+
   def token=(token)
     @token = token
     setup!
@@ -38,36 +51,67 @@ module Scaleway
   end
 
   DEFINITIONS = {
-    "Image" => {
+    "Marketplace" => {
       :all => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/images",
+        :endpoint => "#{Scaleway.marketplace_endpoint}/images",
+      },
+      :find_local_image_by_name => {
+        :method => :get,
+        :endpoint => "#{Scaleway.marketplace_endpoint}/images",
         :default_params => {
-          :organization => Proc.new { Scaleway.organization }
-        }
+            arch: 'x86_64',
+        },
+        :filters => [
+          Proc.new { |params, body, item|
+            item.name.include? params.first }
+        ],
+        :transform => Proc.new { |params, body, item|
+          item[0].versions[0].local_images.keep_if do |local_image|
+            if local_image.zone == Scaleway.zone and local_image.arch == body[:arch]
+              true
+            end
+          end.first
+        },
       },
-      :marketplace => {
+      :find_local_image => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/images",
+        :endpoint => "#{Scaleway.marketplace_endpoint}/images/%s/versions/current",
+        :default_params => {
+            arch: 'x86_64',
+        },
+        :transform => Proc.new { |params, body, item|
+          item.local_images.keep_if do |local_image|
+            if local_image.zone == Scaleway.zone and local_image.arch == body[:arch]
+              true
+            end
+          end.first
+        },
+      },
+    },
+    "Image" => {
+      :all => {
+        :method => :get,
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images" },
         :default_params => {
           :public => true
         }
       },
       :find => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/images/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images/%s" },
       },
       :find_by_name => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/images",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images" },
         :filters => [
-          Proc.new { |item, params| item.name.include? params.first }
+          Proc.new { |params, body, item| item.name.include? params.first }
         ],
-        :transform => Proc.new { |item, params| item.first },
+        :transform => Proc.new { |params, body, item| item.first },
       },
       :create => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/images",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images" },
         :default_params => {
           :name => 'default',
           :root_volume => 'required',
@@ -76,33 +120,33 @@ module Scaleway
       },
       :edit => {
         :method => :put,
-        :endpoint => "#{Scaleway.compute_endpoint}/images/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images/%s" },
       },
       :destroy => {
         :method => :delete,
-        :endpoint => "#{Scaleway.compute_endpoint}/images/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/images/%s" },
       },
     },
     "Volume" => {
       :all => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/volumes",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/volumes" },
       },
       :find => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/volumes/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/volumes/%s" },
       },
       :edit => {
         :method => :put,
-        :endpoint => "#{Scaleway.compute_endpoint}/volumes/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/volumes/%s" },
       },
       :destroy => {
         :method => :delete,
-        :endpoint => "#{Scaleway.compute_endpoint}/volumes/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/volumes/%s" },
       },
       :create => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/volumes",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/volumes" },
         :default_params => {
           :name => 'default',
           :size => 20 * 10**9,
@@ -114,30 +158,30 @@ module Scaleway
     "Ip" => {
       :all => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips" },
       },
       :find => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips/%s" },
       },
       :edit => {
         :method => :put,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips/%s" },
       },
       :destroy => {
         :method => :delete,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips/%s" },
       },
       :reserve => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips" },
         :default_params => {
           :organization => Proc.new { Scaleway.organization },
         }
       },
       :create => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/ips",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/ips" },
         :default_params => {
           :organization => Proc.new { Scaleway.organization },
         }
@@ -146,23 +190,23 @@ module Scaleway
     "Snapshot" => {
       :all => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/snapshots",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/snapshots" },
       },
       :find => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/snapshots/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/snapshots/%s" },
       },
       :edit => {
         :method => :put,
-        :endpoint => "#{Scaleway.compute_endpoint}/snapshots/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/snapshots/%s" },
       },
       :destroy => {
         :method => :delete,
-        :endpoint => "#{Scaleway.compute_endpoint}/snapshots/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/snapshots/%s" },
       },
       :create => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/snapshots",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/snapshots" },
         :default_params => {
           :name => 'default',
           :volume_id => 'required',
@@ -173,54 +217,63 @@ module Scaleway
     "Server" => {
       :all => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers" },
       },
       :power_on => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s/action",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s/action" },
         :default_params => {
           :action => :poweron
         }
       },
       :reboot => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s/action",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s/action" },
         :default_params => {
           :action => :reboot
         }
       },
       :power_off => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s/action",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s/action" },
         :default_params => {
           :action => :poweroff
         }
       },
       :terminate => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s/action",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s/action" },
         :default_params => {
           :action => :terminate
         }
       },
       :find => {
         :method => :get,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s" },
       },
       :edit => {
         :method => :put,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s" },
       },
       :destroy => {
         :method => :delete,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers/%s",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers/%s" },
       },
       :create => {
         :method => :post,
-        :endpoint => "#{Scaleway.compute_endpoint}/servers",
+        :endpoint => Proc.new { "#{Scaleway.compute_endpoint}/servers" },
         :default_params => {
           :name => 'default',
-          :image => Proc.new { Scaleway::Image.find_by_name('Ubuntu').id },
+          :commercial_type => 'VC1S',
+          :image => Proc.new { |params, body|
+            if body[:commercial_type] == 'C1'
+              arch = 'arm'
+            else
+              arch = 'x86_64'
+            end
+            Scaleway::Marketplace.find_local_image_by_name(
+              'Ubuntu Xenial', arch: arch).id
+          },
           :volumes => {},
           :organization => Proc.new { Scaleway.organization },
         }
@@ -257,6 +310,10 @@ module Scaleway
     body.merge! query[:default_params] || {}
     endpoint = query[:endpoint]
 
+    if endpoint.respond_to? :call
+      endpoint = endpoint.call()
+    end
+
     params.each do |param|
       if param.is_a? Hash or param.is_a? RecursiveOpenStruct
         body.merge! param
@@ -266,11 +323,15 @@ module Scaleway
     end
 
     body = Hash[body.map { |k, v|
-      if v.respond_to? :call then [k, v.call()] else [k, v] end
+      if v.respond_to? :call then [k, v.call(params, body)] else [k, v] end
     }]
 
+    if Scaleway.request.nil?
+      raise ::RuntimeError.new("Authentication is missing")
+    end
+
     resp = Scaleway.request.send(query[:method], endpoint, body)
-    body = resp.body
+    response_body = resp.body
     if resp.status == 204
       return
     end
@@ -281,23 +342,23 @@ module Scaleway
       raise Scaleway::APIError, resp
     end
 
-    hash = RecursiveOpenStruct.new(body, :recurse_over_arrays => true)
+    hash = RecursiveOpenStruct.new(response_body, :recurse_over_arrays => true)
 
-    if body.length == 1
-      hash = hash.send(body.keys.first)
+    if response_body.length == 1
+      hash = hash.send(response_body.keys.first)
     end
 
     if query[:filters]
       filters = query[:filters]
       hash = hash.find_all do |item|
         filters.all? do |filter|
-          filter.call(item, params)
+          filter.call(params, body, item)
         end
       end
     end
 
     if query[:transform]
-      hash = query[:transform].call(hash, params)
+      hash = query[:transform].call(params, body, hash)
     end
 
     hash

data/lib/scaleway/version.rb

@@ -1,3 +1,3 @@
 module Scaleway
-  VERSION = '0.2.1'
+  VERSION = '1.0.0'
 end

data/spec/scaleway_spec.rb

@@ -8,23 +8,34 @@ describe Scaleway do
   before do
     Scaleway.organization = organization
     Scaleway.token = token
+    Scaleway.zone = zone
   end
 
   describe "defaults" do
     let(:organization)   { nil }
     let(:token)          { nil }
+    let(:zone)           { nil }
 
-    its(:compute_endpoint) { should eq "https://api.scaleway.com" }
+    its(:compute_endpoint) { should eq "https://cp-par1.scaleway.com" }
     its(:account_endpoint) { should eq "https://account.scaleway.com" }
     its(:token)            { should eq "token_required" }
     its(:organization)     { should eq "organization_required" }
 
-    it { expect(Scaleway::VERSION).to eq "0.2.1" }
+    it { expect(Scaleway::VERSION).to eq "1.0.0" }
+  end
+
+  describe "test ams1" do
+    let(:organization)   { nil }
+    let(:token)          { nil }
+    let(:zone)           { "ams1" }
+
+    its(:compute_endpoint) { should eq "https://cp-ams1.scaleway.com" }
   end
 
   describe "test token and organization" do
     let(:organization)   { "organization_id" }
     let(:token)          { "token_id" }
+    let(:zone)           { nil }
 
     its(:organization)   { should eq "organization_id" }
     its(:token)          { should eq "token_id" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scaleway
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - bchatelard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday