fog-ukcloud 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWExOWRlMmMwNWE1OTJlYWM4NGRkMWE3ZTE1NTg1MDJhNzgxOGNmNg==
+  data.tar.gz: !binary |-
+    NGFmMmE0N2UzY2VjZjQ4ZjE3NDg3NmFiOGMxZTk2NDNhY2Q2YzNjZg==
+SHA512:
+  metadata.gz: !binary |-
+    ZTMyZThmNjIwYjdkYTEzOWNmYjIwNjFkZTBlNzVhMDBjNWIyMzc0MTBhOGI3
+    NmM2NGFhNTA5ZDlhOGYwZDQ1NTljNmZiZWVmMDZlYzczMzg5N2VhOGJlNGYw
+    YWYxM2E3ODQ0YTdjOWVhZDQ2YWNjZTkxZjIwM2UyNTExYTJhMWI=
+  data.tar.gz: !binary |-
+    YjA5ZDY5MmQzMDgyZWY2NGY0MTM0ZWM2MjNhYjdjMTU5Y2M0OWI1OTc2NTc3
+    NTFjNzEwMDU4NDY3MmE4ZmZmMTZiMGEyNjliYTMyNjA5M2UwM2FiNGJiYmJl
+    ZGYwMDQ4ZjFkMmY1MDY0ZDliMDE1MDViOGU4NzNlMjhkZWZjOWQ=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,25 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+
+before_install: gem install bundler -v 1.12.5
+
+script: bundle exec rake record
+
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Gfvy4NhVw0Fr+DVhq4AxvJq5ApdTdyrHd3PcyciUReNp7eRdVv0PecLobwVYIUi3xBJNMWZs8xOIHMMJ2pj+fezNBDsg85HZLO0UcbpwMpllf41SFJFt+JyhQFAkd4Ed2Z4UyFnKrB96+y8eoPcerSKG8KhkibSZkEwTd6wK7Y2Dd90JbozvcIBHujMtB8Uoy5ceABUUynA7aPqVweL8BsS3l8Aq7fWSW9/wDTFgYcyYZb+B96H7zLbH6Zb9RQ5xsXev93aXD9J2sVGKS+Td12P8BmDoT28tD9qe73Fcg7dYYD+gQpLMbPe32AThHBmYPeCLRp6vOcOpmjby2+EItrP8rxJ/imjQbsmhIxham6IBKMeA/J5ytq4b9r10tSiTBewk14icr/Jn6j6dN21R5BSSUI8QZXbo01wD7x5fUwyZBQPbk3DkVeLc5UIxHBZ9a8CQfmMkyeVypXKRStG9nT2JdHm2wESCKgJt9mCpGis/4eVELF0PgcwEWAK/Ktv+VDrTRWGHXAiekVbY2cSFRCvxBScTGz7opMSxmovYm1LqsdFT3FCSK9lnk+oH4OfrQNyr+tCqpQHQeH1LssofLMOeLBp4H1UcbaxDltTs0bDzpXyXx5gXJ5AF1kyoOHuNobrRiyeiLtClFVV65NJqeE0CyUu84dUOv7V55O2D0ak=
+  on:
+    tags: true
+
+
+notifications:
+  slack:
+    secure: WQ1v6XL0he7nxhYUoXMCmQ7mxeSNQsz54z+yVw0LhDDIoWuhPmucV9es/yjTrebe7ZfrM8bmxYLxVVKgphQiXmZx/T76z3zZLNv/BfisLQeT2h1AVxHZ78UK8D3nTrdHM0rvosDv2dq6hC0WxtAZWEP/mGf3Nk+4dBLr4scddYyatApThCD50g1uX/kFs6a44OQ+NrxHFgWgN3NUkUDMMylhtd1mXmy1UDPlElc5h/tAspnrfOh4LwZeKl7lz1CdNDMJURwx8ZdVY22EvwPZISxCa4X6oYpoRoXt2zJ/JJE+H6ICwbo1nXbR6dMHnaZ0EWqgkIQUpGQixAdrsyBt8ddV+lrl6HzyMJcno7aae68oHyipJ5pv8/qQsbLlMlOPWCMeIXZpnzaE/dDLLy/3MZHUa4AWfv0xIHKJN7bhKz8dxfc8bqy/KHvIbbAAWUUBub2F9SRb4LK265skIZmIOLCgqAtKp3THwmhucJhLX4+Gt5ioCx6Cw/HDLD8g4uqR9eUPpRyLVn/ntEzERNPhqWzaHHesIVb3mNfOW3AtLkKfxtdICX4be5AGuhbvKljiFDyf7X582UrbfmfnV1Tjb8elDl8i9/bXFrrv+XtdFuvp2aioIZp81KX9BMVBXiDfugTVLjvwYuGxbxP75cym7jg1uYsMwvKduouQ+N9BRxE=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fog-ukcloud.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tim Lawrence
+
+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/README.md

@@ -0,0 +1,38 @@
+[![Build Status](https://travis-ci.org/UKCloud/fog-ukcloud.svg?branch=master)](https://travis-ci.org/UKCloud/fog-ukcloud)
+[![Gem Version](https://badge.fury.io/rb/fog-ukcloud.svg)](http://badge.fury.io/rb/fog-ukcloud)
+
+
+# UKCloud Portal API Client
+
+## Introduction
+
+Collection and Model representation in ukcloud fog provider.
+
+```no-highlight
+todo: describe model
+```
+
+### Actions
+
+Every collection supports the following methods:
+
+Method Name       | Lazy Load
+----------------- | ---------
+get(id)           | false
+get_by_name(name) | false
+all               | true
+
+## Initialization
+
+```ruby
+require 'fog/ukcloud'
+
+ukcloud = Fog::Compute::UKCloud.new(
+  :ukcloud_username => "<user email address>",
+  :ukcloud_password => "<password>",
+  :ukcloud_host => '<portal hostname or omit for default>'
+)
+```
+
+
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :record do
+  ENV['VCR_RECORDING'] = 'true'
+  sh("export FOG_MOCK=false && bundle exec rspec")
+end

data/fog-ukcloud.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fog/ukcloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fog-ukcloud"
+  spec.version       = Fog::Ukcloud::VERSION
+  spec.authors       = ["Tim Lawrence"]
+  spec.email         = ["tlawrence@ukcloud.com"]
+
+  spec.summary       = "Module for 'Fog' gem to support UKCloud's REST API"
+  spec.homepage      = "https://www.ukcloud.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "webmock"
+
+  spec.add_dependency 'fog-core'
+  spec.add_dependency 'fog-json'
+  spec.add_dependency 'fog-xml'
+end

data/lib/fog/ukcloud.rb

@@ -0,0 +1,14 @@
+require 'fog/core'
+require 'fog/ukcloud/errors'
+
+module Fog
+  module UKCloud
+    extend Fog::Provider
+    service(:compute, 'Compute')
+  end
+
+  module Compute
+    autoload :UKCloud, File.expand_path('../ukcloud/compute', __FILE__)
+  end
+
+end

data/lib/fog/ukcloud/compute.rb

@@ -0,0 +1,105 @@
+require 'fog/xml'
+require 'fog/json'
+
+module Fog
+  module Compute
+    class UKCloud < Fog::Service
+
+      recognizes :ukcloud_endpoint
+      requires :ukcloud_username, :ukcloud_password
+      secrets :ukcloud_password
+
+      # Models
+      model_path 'fog/ukcloud/models/compute'
+      #collection :servers
+      #model      :server
+
+      # Requests
+      request_path 'fog/ukcloud/requests/compute'
+      #request :power_on_vm
+      request :post_login_session
+      request :get_my_vm
+      request :get_ping
+
+      class Real
+
+        UKCLOUD_DEFAULT_ENDPOINT = 'portal.skyscapecloud.com'
+        attr_reader :ukcloud_username, :ukcloud_endpoint, :cookies
+
+        def initialize(options={})
+          @ukcloud_username = options[:ukcloud_username]
+          @ukcloud_password = options[:ukcloud_password]
+          @ukcloud_endpoint = options[:ukcloud_endpoint] || UKCLOUD_DEFAULT_ENDPOINT
+          @path = 'api'
+          @connection_options = options[:connection_options] || {}
+          @connection_options[:omit_default_port] = true unless @connection_options[:omit_default_port]
+          @cookies = ''
+
+          scheme = 'https'
+          port = '443'
+          url = sprintf('%s://%s:%s', scheme, @ukcloud_endpoint, port)
+
+          @connection = Fog::XML::Connection.new(url, false, @connection_options)
+        end
+
+
+        def get_cookies
+          login if @cookies.empty?
+          @cookies
+        end
+
+
+        def request(params)
+          path = params[:path]
+          params[:body] = Fog::JSON.encode(params[:body]) if params[:body]
+          begin
+
+
+            headers = {
+              'Accept' => 'application/json',
+              'Content-Type' => 'application/json',
+              'Cookie' => get_cookies
+            }
+
+            @connection.request({
+              :body       => params[:body],
+              :expects    => params[:expects],
+              :headers    => headers.merge!(params[:headers] || {}),
+              :idempotent => params[:idempotent],
+              :method     => params[:method],
+              :parser     => params[:parser],
+              :path       => path,
+              :query      => params[:query]
+            })
+          rescue Excon::Errors::HTTPStatusError => error
+            raise case error
+              when Excon::Errors::BadRequest   then Fog::UKCloud::Errors::BadRequest.slurp(error);
+              when Excon::Errors::Unauthorized then Fog::UKCloud::Errors::Unauthorised.slurp(error);
+              when Excon::Errors::Forbidden    then Fog::UKCloud::Errors::Forbidden.slurp(error);
+              when Excon::Errors::Conflict     then Fog::UKCloud::Errors::Conflict.slurp(error);
+            else
+              Fog::UKCloud::Errors::ServiceError.slurp(error)
+            end
+          end
+        end
+
+
+        def login
+          response = post_login_session
+          @cookies = response.headers['Set-Cookie']
+          if response[:cookies].empty? && response.status == 201 then
+            err =  RuntimeError.new("No Cookie In Response")
+            raise Fog::UKCloud::Errors::ServiceError.slurp(err)
+          end
+
+        end
+
+      end #Real
+
+      class Mock
+
+      end
+
+    end #UKCloud
+  end #Compute
+end #Fog

data/lib/fog/ukcloud/errors.rb

@@ -0,0 +1,32 @@
+module Fog
+  module UKCloud
+    module Errors
+      class ServiceError < Fog::Errors::Error
+        attr_reader :status_code
+
+        def self.slurp(error, service=nil)
+          status_code = nil
+          if error.response
+            status_code = error.response.status
+            unless error.response.body.empty?
+              begin
+                document = Nokogiri::XML(error.response.body)
+                message = document.xpath('//error').text
+              rescue => e
+                Fog::Logger.warning("Received exception '#{e}' while decoding>> #{error.response.body}")
+                message = error.response.body
+              end
+            end
+          end
+
+          new_error = super(error, message)
+          new_error.instance_variable_set(:@status_code, status_code)
+          new_error
+        end
+      end
+
+      class Unauthorised < ServiceError; end
+    end
+
+  end
+end

data/lib/fog/ukcloud/requests/compute/get_my_vm.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class UKCloud
+      class Real
+        def get_my_vm
+
+          request(
+            :expects => 200,
+            :method  => 'GET',
+            :parser  => Fog::ToHashDocument.new,
+            :path    => "#{@path}/my_vm"
+          )
+
+        end
+      end
+    end
+  end
+end

data/lib/fog/ukcloud/requests/compute/get_ping.rb

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class UKCloud
+      class Real
+        def get_ping
+
+          request(
+            :expects => 200,
+            :method  => 'GET',
+            #:parser  => Fog::ToHashDocument.new,
+            :path    => "#{@path}/ping"
+          )
+
+        end
+      end
+    end
+  end
+end

data/lib/fog/ukcloud/requests/compute/post_login_session.rb

@@ -0,0 +1,39 @@
+require 'fog/json'
+
+module Fog
+  module Compute
+    class UKCloud
+      class Real
+        def post_login_session
+
+          body = {
+            :email => @ukcloud_username,
+            :password => @ukcloud_password
+          }
+
+          begin
+
+            @connection.request(
+              :headers => {'Accept' => 'application/json'},
+              :expects => 201,
+              :method  => 'POST',
+              :body => Fog::JSON.encode(body),
+              :path    => "#{@path}/authenticate"
+            )
+          rescue Excon::Errors::HTTPStatusError => error
+            raise case error
+              when Excon::Errors::BadRequest   then Fog::UKCloud::Errors::BadRequest.slurp(error);
+              when Excon::Errors::Unauthorized then Fog::UKCloud::Errors::Unauthorised.slurp(error);
+              when Excon::Errors::Forbidden    then Fog::UKCloud::Errors::Forbidden.slurp(error);
+              when Excon::Errors::Conflict     then Fog::UKCloud::Errors::Conflict.slurp(error);
+            else
+              Fog::UKCloud::Errors::ServiceError.slurp(error)
+            end
+          end
+
+
+        end
+      end
+    end
+  end
+end

data/lib/fog/ukcloud/service.rb

@@ -0,0 +1,47 @@
+
+module Fog
+  module UKCloud
+    class Service
+
+      def ws_enduser_url(url=nil)
+        @ws_enduser_url = url || Fog::UKCloud::DEFAULT_WS_ENDUSER_URL
+      end
+
+      def _request(options)
+        http_method = options[:http_method] || :get
+        @request_url = "#{@ws_enduser_url}/#{options[:method]}"
+
+        params = {headers: headers}
+        params[:expects] = options[:expected] || [200, 201]
+        unless options[:body].nil?
+          params[:body] = options[:body]
+        end
+        params[:read_timeout] = 360
+
+        # initialize connection object
+        @connection = Fog::Core::Connection.new(@request_url, false, params)
+
+        # send request
+        begin
+          response = @connection.request(:method => http_method)
+        rescue Excon::Errors::Timeout
+          # raise an error
+          raise Fog::UKCloud::Errors::RequestTimeOut.new(
+              "Request timed out after: #{60 unless params[:read_timeout]}"
+          )
+        end
+
+        # decode the response and return it
+        Fog::JSON.decode(response.body)
+      end
+
+      def headers(options={})
+        {'Content-Type' => 'application/json'}.merge(options[:headers] || {})
+      end
+
+      def login
+
+      end
+    end
+  end
+end

data/lib/fog/ukcloud/version.rb

@@ -0,0 +1,5 @@
+module Fog
+  module Ukcloud
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: fog-ukcloud
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Lawrence
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fog-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tlawrence@ukcloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fog-ukcloud.gemspec
+- lib/fog/ukcloud.rb
+- lib/fog/ukcloud/compute.rb
+- lib/fog/ukcloud/errors.rb
+- lib/fog/ukcloud/requests/compute/get_my_vm.rb
+- lib/fog/ukcloud/requests/compute/get_ping.rb
+- lib/fog/ukcloud/requests/compute/post_login_session.rb
+- lib/fog/ukcloud/service.rb
+- lib/fog/ukcloud/version.rb
+homepage: https://www.ukcloud.com
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Module for 'Fog' gem to support UKCloud's REST API
+test_files: []