hyperb 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 451eaa5bd6d96d215b204e67b80b087048cf5b91
-  data.tar.gz: c4b03081daa2592a264504f31028cb94fc49d813
+  metadata.gz: 9200fb1c5348757773d70f6940a0e10cbee1564d
+  data.tar.gz: e15cc748b6142cb74c6fdcf34a82f8954eb0b448
 SHA512:
-  metadata.gz: c23a4d03fb11785c4beb7529adf6342df4c2ad04fac7cd36a953626c4ab8dbef8c380fe2cebfc96e2251e3540fd64bac83c5b6c1af1bed3ea406f3d6d0941848
-  data.tar.gz: 94ca447128b1273a91449c32cef90d20f414ab5e7ce2c5337f799c63d96b1095a38704dccbf625bd3a41b7f621bb01abea6d29f34a8bdf49c86e708caf536f5c
+  metadata.gz: 15bfbc0569c83146c717d82a641830a1d6d94f23f2e77bd543dcda5066f8aa652d3a0425634391ab150dc292b3900b5318e005d81ac5e614ba4077af9add91bf
+  data.tar.gz: 6a62201383ce5e56f50219daf4f2a83d3b76380cb9c313a8c077a615fc074f3e327addc4b865bf9aedc3f9049abc5349b7b0e2d1b2c7c8f8829e2f2ef1975850

data/Makefile

@@ -1,5 +1,8 @@
 .PHONY: test
 
+r:
+	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec ruby test.rb
+
 build:
 	docker build -t hyperb .
 
@@ -13,4 +16,4 @@ rake:
 	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec rake
 
 rubocop:
-	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec rake rubocop
+	docker run --rm -it -v $(PWD):/usr/src hyperb bundle exec rake rubocop

data/README.md

@@ -142,6 +142,7 @@ For more usage examples, please see the full [documentation]().
 * floating ip list
 * floating ip attach
 * floating ip detach
+* floating ip name
 
 ### Compose
 
@@ -158,6 +159,8 @@ For more usage examples, please see the full [documentation]().
 
 * create service
 * remove service
+* inspect service
+* list services
 
 ### Misc.
 

data/circle.yml

@@ -3,11 +3,9 @@ dependencies:
     - 'rvm-exec 2.2.0 bundle install'
     - 'rvm-exec 2.3.0 bundle install'
     - 'rvm-exec 2.4.0 bundle install'
-    - 'rvm-exec ruby-head bundle install'
 
 test:
   override:
     - 'rvm-exec 2.2.0 bundle exec rake'
     - 'rvm-exec 2.3.0 bundle exec rake'
-    - 'rvm-exec 2.4.0 bundle exec rake'
-    - 'rvm-exec ruby-head bundle exec rake'
+    - 'rvm-exec 2.4.0 bundle exec rake'

data/examples/README.md

@@ -284,6 +284,12 @@ Returns an array of floating ip objects
 client.fips_ls
 ```
 
+#### fip_name
+
+```ruby
+client.fip_name ip: '8.8.8.8', name: 'proxy'
+```
+
 #### fip_detach
 
 ```ruby
@@ -341,6 +347,22 @@ client.remove_service name: 'srvc1'
 client.remove_service name: 'srvc1', keep: true
 ````
 
+#### services
+
+Returns an Array of downcased symbols
+
+```ruby
+client.services
+```
+
+#### inspect_service
+
+Returns an Hash containing service fields
+
+```ruby
+client.inspect_service(name: 'srvc1')
+```
+
 ## Snapshot API
 
 Return hash containing snapshot information

data/lib/hyperb/containers/containers.rb

@@ -57,7 +57,7 @@ module Hyperb
 
     # remove the container id
     #
-    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/delete.html
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Container/remove.html
     #
     # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
     # @raise [Hyperb::Error::NotFound] raised when container can't be found.

data/lib/hyperb/network/fips.rb

@@ -98,5 +98,27 @@ module Hyperb
       fips = JSON.parse(Hyperb::Request.new(self, path, query, 'post').perform)
       fips
     end
+
+    # set a name for floating ip
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Network/fip_name.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::NotFound] raised when fip is not found
+    # @raise [Hyperb::Error::Conflict] raised when name already exists
+    # @raise [Hyperb::Error::InternalServerError] raised when server returns 5xx
+    #
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :ip fip
+    # @option params [String] :name the name
+    def fip_name(params = {})
+      raise ArgumentError, 'Invalid Arguments' unless check_arguments(params, 'ip', 'name')
+      path = '/fips/name'
+      query = {}
+      query[:ip] = params[:ip] if params.key?(:ip)
+      query[:name] = params[:name] if params.key?(:name)
+      Hyperb::Request.new(self, path, query, 'post').perform
+    end
   end
 end

data/lib/hyperb/services/services.rb

@@ -18,20 +18,23 @@ module Hyperb
     # @return [Hash] Hash containing service information.
     #
     # @param params [Hash] A customizable set of params.
-    # @param params image [String] service name
-    # @param params name [String] image name
-    # @param params replicas [Fixnum] numer of replicas
-    # @param params service_port [Fixnum] service port
-    # @param params container_port [Fixnum] container port
-    # @param params labels [Hash] hash containing labels
-    # @param params entrypoint [String] entrypoint
-    # @param params cmd [String] command
-    # @param params env [Array] array of envs ["env=value", ["env2=value"]]
-    # @param params algorithm [String] algorithm of the service, 'roundrobin', 'leastconn'
-    # @param params protocol [String] prot
-    # @param params workingdir [String] working directory
+    # @param params [String] :image  service name
+    # @param params [String] :name image name
+    # @param params [Fixnum] :replicas numer of replicas
+    # @param params [Fixnum] :serviceport service port
+    # @param params [Fixnum] :containerport container port
+    # @param params [Hash] :labels hash containing labels
+    # @param params [String] :entrypoint entrypoint
+    # @param params [String] :cmd command
+    # @param params [Boolean] :stdin keep STDIN open even if not attached.
+    # @param params [Array] :env array of envs ["env=value", ["env2=value"]]
+    # @param params [String] :algorithm algorithm of the service, 'roundrobin', 'leastconn'
+    # @param params [String] :protocol prot
+    # @param params [String] :workingdir working directory
+    # @param params [Boolean] :sessionaffinity whether the service uses sticky sessions.
+    # @param params [String] :securitygroups security group for the container.
     def create_service(params = {})
-      valid = check_arguments(params, 'name', 'image', 'replicas', 'service_port', 'labels')
+      valid = check_arguments(params, 'name', 'image', 'replicas', 'serviceport', 'labels')
       raise ArgumentError, 'Invalid arguments.' unless valid
       path = '/services/create'
       body = {}
@@ -55,5 +58,32 @@ module Hyperb
       query[:keep] = params[:keep] if params.key?(:keep)
       Hyperb::Request.new(self, path, query, 'delete').perform
     end
+
+    # inspect a service
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Service/inspect.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::InternalServerError] raised hyper returns 5xx.
+    #
+    # @param params [Hash] A customizable set of params.
+    # @option params [String] :name service name.
+    def inspect_service(params = {})
+      valid = check_arguments(params, 'name')
+      raise ArgumentError, 'Invalid arguments.' unless valid
+      path = '/services/' + params[:name]
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, {}, 'get').perform))
+    end
+
+    # list service
+    #
+    # @see https://docs.hyper.sh/Reference/API/2016-04-04%20[Ver.%201.23]/Service/list.html
+    #
+    # @raise [Hyperb::Error::Unauthorized] raised when credentials are not valid.
+    # @raise [Hyperb::Error::InternalServerError] raised hyper returns 5xx.
+    def services
+      path = '/services'
+      downcase_symbolize(JSON.parse(Hyperb::Request.new(self, path, {}, 'get').perform))
+    end
   end
 end

data/lib/hyperb/version.rb

@@ -1,3 +1,3 @@
 module Hyperb
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.3.3'.freeze
 end

data/spec/fixtures/inspect_service.json

@@ -0,0 +1,39 @@
+{
+  "Name": "http",
+  "Image": "nginx",
+  "WorkingDir": "",
+  "ContainerSize": "s4",
+  "SSLCert": "",
+  "NetMode": "bridge",
+  "StopSignal": "SIGTERM",
+  "ServicePort": 80,
+  "ContainerPort": 80,
+  "Replicas": 3,
+  "HealthCheckInterval": 3,
+  "HealthCheckFall": 3,
+  "HealthCheckRise": 2,
+  "Algorithm": "roundrobin",
+  "Protocol": "tcp",
+  "Stdin": false,
+  "Tty": false,
+  "SessionAffinity": false,
+  "Entrypoint": [],
+  "Cmd": [],
+  "Env": [],
+  "Volumes": {},
+  "Labels": {
+    "app": "nginx"
+  },
+  "SecurityGroups": {},
+  "IP": "172.16.55.36",
+  "Tenant": "b8dc36865f4b480683dabb25598d61c4",
+  "FIP": "",
+  "Message": "Scaling complete",
+  "Created": "2016-10-08T12:08:33.934Z",
+  "Status": "active",
+  "Containers": [
+    "33cd52f7af63391c9b9eb578130bd46f65f3e2c00ccbe80b9ee882cf40c6043b",
+    "54e3d0724f1d2b4429b08e3192c9ba13c93bd8d9077b391e6129e976eb713b7e",
+    "a35a66d91e0c0740e36f9f2e43db406fefe964f5a483a8137d9c08472860a53e"
+  ]
+}

data/spec/fixtures/services.json

@@ -0,0 +1,41 @@
+[
+  {
+    "Name": "http",
+    "Image": "nginx",
+    "WorkingDir": "",
+    "ContainerSize": "s4",
+    "SSLCert": "",
+    "NetMode": "bridge",
+    "StopSignal": "SIGTERM",
+    "ServicePort": 80,
+    "ContainerPort": 80,
+    "Replicas": 3,
+    "HealthCheckInterval": 3,
+    "HealthCheckFall": 3,
+    "HealthCheckRise": 2,
+    "Algorithm": "roundrobin",
+    "Protocol": "tcp",
+    "Stdin": false,
+    "Tty": false,
+    "SessionAffinity": false,
+    "Entrypoint": [],
+    "Cmd": [],
+    "Env": [],
+    "Volumes": {},
+    "Labels": {
+      "app": "nginx"
+    },
+    "SecurityGroups": {},
+    "IP": "172.16.55.36",
+    "Tenant": "b8dc36865f4b480683dabb25598d61c4",
+    "FIP": "",
+    "Message": "Scaling complete",
+    "Created": "2016-10-08T12:08:33.934Z",
+    "Status": "active",
+    "Containers": [
+      "33cd52f7af63391c9b9eb578130bd46f65f3e2c00ccbe80b9ee882cf40c6043b",
+      "54e3d0724f1d2b4429b08e3192c9ba13c93bd8d9077b391e6129e976eb713b7e",
+      "a35a66d91e0c0740e36f9f2e43db406fefe964f5a483a8137d9c08472860a53e"
+    ]
+  }
+]

data/spec/network_spec.rb

@@ -88,6 +88,26 @@ RSpec.describe Hyperb::Network do
     end
   end
 
+  describe '#fip_name' do
+
+    it 'should raise ArgumentError when ip is not provided' do
+      expect { @client.fip_name(name: 'test') }.to raise_error(ArgumentError)
+    end
+
+    it 'should raise ArgumentError when name is not provided' do
+      expect { @client.fip_name(ip: '8.8.8.8') }.to raise_error(ArgumentError)
+    end
+
+    it 'request to the correct path should be made' do
+      path = @base_path + '/name?ip=8.8.8.8&name=haproxy'
+      stub_request(:post, path)
+      .to_return(body: "")
+
+      @client.fip_name(ip: '8.8.8.8', name: 'haproxy')
+      expect(a_request(:post, path)).to have_been_made
+    end
+  end
+
   describe '#fip_release' do
 
     it 'should raise ArgumentError when ip is not provided' do

data/spec/services_spec.rb

@@ -8,7 +8,57 @@ RSpec.describe Hyperb::Services do
     @base_path = Hyperb::Request::BASE_URL + Hyperb::Request::VERSION + '/services'
   end
 
-  describe '#remove_container' do
+  describe '#inspect_service' do
+
+    it 'should raise ArgumentError when name is missing' do
+      expect { @client.inspect_service }.to raise_error(ArgumentError)
+    end
+
+    it 'request to the correct path should be made' do
+      path = @base_path + '/service1'
+
+      stub_request(:get, path)
+      .to_return(body: fixture('./inspect_service.json'))
+
+      @client.inspect_service(name: 'service1')
+      expect(a_request(:get, path)).to have_been_made
+    end
+
+    it 'return correct attrs' do
+      path = @base_path + '/service1'
+
+      stub_request(:get, path)
+      .to_return(body: fixture('./inspect_service.json'))
+
+      s = @client.inspect_service(name: 'service1')
+      expect(s.is_a?(Hash)).to be true
+    end
+  end
+
+  describe '#services' do
+
+    it 'request to the correct path should be made' do
+      path = @base_path
+
+      stub_request(:get, path)
+      .to_return(body: fixture('./services.json'))
+
+      @client.services
+      expect(a_request(:get, path)).to have_been_made
+    end
+
+    it 'return correct attrs' do
+      path = @base_path
+
+      stub_request(:get, path)
+      .to_return(body: fixture('./services.json'))
+
+      s = @client.services
+      expect(s.is_a?(Array)).to be true
+    end
+  end
+
+  describe '#remove_service' do
 
     it 'should raise ArgumentError when name is not provided' do
       expect { @client.remove_service }.to raise_error(ArgumentError)
@@ -61,11 +111,11 @@ RSpec.describe Hyperb::Services do
     it 'request to the correct path should be made with name' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)
@@ -79,12 +129,12 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with entrypoint' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
         entrypoint: 'entry.sh',
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)
@@ -98,12 +148,12 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with cmd' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
         cmd: 'echo 1',
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)
@@ -117,12 +167,12 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with env' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
         env: ['ENV=123'],
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)
@@ -136,12 +186,12 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with protocol' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
         protocol: 'https',
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)
@@ -155,11 +205,11 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with algorithm' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         image: 'nginx',
         replicas: 2,
-        container_port: 80,
+        containerport: 80,
         algorithm: 'roundrobin',
         labels: {}
       }
@@ -174,12 +224,12 @@ RSpec.describe Hyperb::Services do
     it 'correct request should be made with workingdir' do
       path = @base_path + '/create'
       body = {
-        service_port: 80,
+        serviceport: 80,
         name: 'name1',
         workingdir: '/path',
         image: 'nginx',
         replicas: 2,
-        container_port: 80,
+        containerport: 80,
         labels: {}
       }
       stub_request(:post, path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.3
 platform: ruby
 authors:
 - drish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -180,9 +180,11 @@ files:
 - spec/fixtures/images.json
 - spec/fixtures/inspect_container.json
 - spec/fixtures/inspect_image.json
+- spec/fixtures/inspect_service.json
 - spec/fixtures/inspect_volume.json
 - spec/fixtures/remove_container.json
 - spec/fixtures/remove_image.json
+- spec/fixtures/services.json
 - spec/fixtures/volumes.json
 - spec/helper.rb
 - spec/image_spec.rb