qubell_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 146dae04948ecfbec091e7ec069a3531bbb64393
+  data.tar.gz: c213ce1c5079a8678a9268566e83f4289415d3ee
+SHA512:
+  metadata.gz: 8b814e2fb22a16bac6dfc60c2c609d4a74ed8237d13cce9575213bc793939aa1a54cb61e0855fa38633d808999fae357dda21866c2952ec871f79d38188b9d7c
+  data.tar.gz: f6422d2ad4d981005e66a6ea4ae13744d387d75512827e37030ea822d6f7460b794fa7c47622ecf3d3e2cc792494bd55526f84ff40bcc8a18521b4014b116375

data/.gitignore

@@ -0,0 +1,37 @@
+/.idea/
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+/out/
+/vendor/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - test/**/*
+    - vendor/**/*
+    - tmp/**/*

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.0
+install:
+  - bundle install --path vendor/bundle
+script:
+  - bundle exec rake

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'rest-client', '~> 2.0.0'
+
+group :development do
+  gem 'rake',         '~> 11.2.0'
+  gem 'webmock',      '~> 2.1.0'
+  gem 'rspec',        '~> 3.5.0'
+  gem 'rubocop',      '~> 0.41.0'
+  gem 'yard',         '~> 0.9.0'
+  gem 'factory_girl', '~> 4.7.0'
+  gem 'simplecov',    '~> 0.12.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nikolay Yurin
+
+MIT License
+
+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,6 @@
+Ruby Qubell API
+===============
+
+Qubell API wrapper on Ruby
+
+[![Build Status](https://api.travis-ci.org/yurinnick/qubell-ruby-api.svg)](https://travis-ci.org/yurinnick/qubell-ruby-api)

data/Rakefile

@@ -0,0 +1,33 @@
+# Encoding: utf-8
+
+require 'bundler'
+require 'bundler/gem_tasks'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  $stderr.puts e.message
+  exit e.status_code
+end
+
+require 'rake'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['test/spec/**/*_spec.rb']
+end
+
+desc 'Run RSpec with code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+desc 'Run RuboCop over itself'
+RuboCop::RakeTask.new(:code_style) do |task|
+  task.fail_on_error = false
+end
+
+task default: [:spec, :code_style]

data/lib/qubell/api_call.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+require 'qubell/errors'
+
+module Qubell
+  # Implements Qubell API HTTP call helpers
+  class APICall
+    %w(get post put delete).each do |http_method|
+      define_singleton_method(http_method.to_sym) do |path, *args|
+        Qubell.configure do |config|
+          RestClient::Resource.new(
+            "#{config.endpoint}#{path}",
+            config.username,
+            config.password
+          ).send(http_method.to_sym, *args) do |response|
+            handle_response(response)
+          end
+        end
+      end
+    end
+
+    # @param [String] data
+    def self.handle_response(response)
+      if response.code == 200
+        case response.headers[:content_type]
+        when 'application/json' then JSON.parse(response, symbolize_names: true)
+        when 'application/x-yaml' then YAML.load response
+        else response.empty? ? nil : response
+        end
+      else
+        handle_error(response.code)
+      end
+    end
+
+    # @param [String] response
+    def self.handle_error(code)
+      case code
+      when 400 then raise Qubell::ExecutionError
+      when 401 then raise Qubell::AuthenticationError
+      when 403 then raise Qubell::PermissionsDeniedError
+      when 404 then raise Qubell::ResourceUnavaliable
+      when 409 then raise Qubell::WorkflowError
+      else raise Qubell::BaseError, code
+      end
+    end
+  end
+end

data/lib/qubell/application.rb

@@ -0,0 +1,71 @@
+# Encoding: utf-8
+# Qubell application class
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+require 'qubell/base'
+require 'qubell/revision'
+require 'qubell/api_call'
+require 'qubell/instance'
+require 'qubell/organization'
+
+# Main Qubell module
+module Qubell
+  # Qubell application class
+  class Application < Base
+    attr_reader :organization
+
+    def initialize(args)
+      super
+      @organization = args[:organization]
+    end
+
+    # Get list of all revisions for given application.
+    # @return [Array<Qubell::Revision>] revisions info
+    def revisions
+      Qubell::APICall.get("/applications/#{@id}/revisions").map do |rev|
+        Qubell::Revision.new(rev)
+      end
+    end
+
+    # Get list of all instances for given application.
+    # @return [Array<Qubell::Instance>] revisions info
+    def instances
+      # Qubell public API is too enterprise for just getting list of instances
+      # by application ID. Actually there is no method for this yet.
+      # So, store ID of organization in Application class and to get a list of
+      # instances we init new organization class, get all environments in this
+      # organization, get all instances in this environment and finally
+      # filter them by application.
+      # Like in one russian fairytail: "his death is at the end of the needle,
+      # that needle is in the egg, then egg is in a duck, that duck is in a
+      # hare, the hare is in the trunk, and the trunk stands on a high oak"
+      Qubell::Organization.new(id: @organization).environments
+                          .map(&:instances).flatten.select do |instance|
+        instance.instance_of_app?(self)
+      end
+    end
+
+    # Get the application instance status.
+    # @param [String] content new manifest content
+    # @return [String] instances status info
+    def update(content)
+      Qubell::APICall.put("/applications/#{@id}/manifest",
+                          content,
+                          content_type: 'application/x-yaml')[:version]
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError, 'currect manifest is incorrect'
+    end
+
+    # Launch new instance of given application.
+    # @param [Hash<String => String>] args map of configuration parameters
+    # @return [Qubell::Instance] revisions info
+    def launch(args)
+      id = Qubell::APICall.put("/applications/#{@id}/launch",
+                               args.to_json,
+                               content_type: 'application/json')[:id]
+      instances.select { |instance| instance.id == id }.first
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError, 'currect manifest is incorrect'
+    end
+  end
+end

data/lib/qubell/base.rb

@@ -0,0 +1,44 @@
+# Encoding: utf-8
+# Qubell API wrapper
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'json'
+
+# Main Qubell module
+module Qubell
+  # Class wrapper for HTTP requests
+  class Base
+    # @return [String] object id
+    attr_reader :id
+    # @return [String] object name
+    attr_reader :name
+
+    def initialize(args)
+      @id = if args[:id].nil?
+              raise ArgumentError,
+                    "can't initialize #{self.class.name} without id"
+            else
+              args[:id]
+            end
+      @name = args[:name]
+    end
+
+    def to_json(options)
+      to_hash.to_json(options)
+    end
+
+    def to_s
+      %("id": "#{@id}", "name": "#{@name}")
+    end
+
+    def to_hash
+      { id: @id, name: @name }
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) && id == other.id && name == other.name
+    end
+  end
+end

data/lib/qubell/configuration.rb

@@ -0,0 +1,34 @@
+# Main Qubell module
+module Qubell
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  # Store configuration settings
+  class Configuration
+    attr_accessor :domain, :api_version, :username, :password
+    attr_reader :endpoint
+
+    def initialize
+      @domain = 'https://express.tonomi.com'
+      @api_version = '1'
+    end
+
+    def endpoint
+      "#{@domain}/api/#{@api_version}"
+    end
+
+    def to_s
+      %({"domain": "#{@domain}","api_version": "#{@api_version}",) +
+        %("username": "#{@username}","password": "#{@password}"})
+    end
+  end
+end

data/lib/qubell/environment.rb

@@ -0,0 +1,64 @@
+# Encoding: utf-8
+# Qubell application class
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+require 'yaml'
+require 'qubell/base'
+require 'qubell/api_call'
+require 'qubell/instance'
+
+module Qubell
+  # Implements Qubell environment interface
+  class Environment < Base
+    attr_reader :is_default
+
+    def initialize(args)
+      super
+      @is_default = args[:isDefault]
+    end
+
+    def policies
+      Qubell::APICall.get("/environments/#{@id}")[:policies]
+    end
+
+    # noinspection RubyStringKeysInHashInspection
+    def policies=(value)
+      Qubell::APICall.put("/environments/#{@id}",
+                          { policies: value }.to_yaml,
+                          content_type: 'application/x-yaml')
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError
+    end
+
+    def markers
+      Qubell::APICall
+        .get("/environments/#{@id}/markers")[:markers].map { |m| m[:name] }
+    end
+
+    def markers=(value)
+      Qubell::APICall.put("/environments/#{@id}/markers",
+                          { markers: value.each { |v| { name: v } } }.to_json,
+                          content_type: 'application/json')
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError
+    end
+
+    def properties
+      Qubell::APICall.get("/environments/#{@id}/properties")[:properties]
+    end
+
+    def properties=(value)
+      Qubell::APICall.put("/environments/#{@id}/properties",
+                          { properties: value }.to_json,
+                          content_type: 'application/json')
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError
+    end
+
+    def instances
+      Qubell::APICall.get("/environments/#{@id}/instances").map do |inst|
+        Qubell::Instance.new(inst)
+      end
+    end
+  end
+end

data/lib/qubell/errors.rb

@@ -0,0 +1,62 @@
+# Encoding: utf-8
+
+module Qubell
+  # Base exception for Qubell module
+  class BaseError < StandardError
+    attr_reader :error_code
+
+    def initialize(error_code, msg = 'unknown status code')
+      super msg
+      @error_code = error_code
+    end
+  end
+
+  # Common Qubell API exception
+  class ExecutionError < Qubell::BaseError
+    def initialize(msg = 'instance is a submodule or active')
+      super '400', msg
+    end
+  end
+
+  # Authentication exception for Qubell module
+  class AuthenticationError < Qubell::BaseError
+    def initialize(msg = 'invalid credentials')
+      super '401', msg
+    end
+  end
+
+  # Invalid permissions exception for Qubell module
+  class PermissionsDeniedError < Qubell::BaseError
+    def initialize(msg = 'insufficient privileges')
+      super '403', msg
+    end
+  end
+
+  # Unavaliable resource exception for Qubell module
+  class ResourceUnavaliable < Qubell::BaseError
+    def initialize(msg = 'resource doesn’t exist')
+      super '404', msg
+    end
+  end
+
+  # Workflow exception for Qubell module
+  class WorkflowError < Qubell::BaseError
+    def initialize(msg = 'another workflow is already running')
+      super '409', msg
+    end
+  end
+
+  # Invalid input exception for Qubell module
+  class FormatError < ExecutionError
+    def initialize(msg = 'incorrect format or data')
+      super
+    end
+  end
+
+  # Instance destoy exception for Qubell module
+  class DestroyError < ExecutionError
+    def initialize(msg = 'specified instance is either a submodule or active')
+      super
+    end
+  end
+end

data/lib/qubell/instance.rb

@@ -0,0 +1,64 @@
+# Encoding: utf-8
+# Qubell application class
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+require 'qubell/base'
+
+module Qubell
+  # Implement Qubell application interface
+  class Instance < Base
+    attr_reader :environment
+    attr_reader :revision
+
+    def initialize(args)
+      super
+      @environment = args[:environment]
+      @revision = args[:revision]
+    end
+
+    # Runs the specified application instance workflow.
+    # @param [String] workflow instance workflow name
+    # @param [Hash{String => String}] workflow instance workflow name
+    # @return [Hashes{String => String}] instance id
+    def launch_workflow(workflow, _args)
+      Qubell::APICall.get("/instances/#{@id}/#{workflow}")
+    end
+
+    # Associates user data with the instance.
+    # @param [String] data JSON-encoded user data
+    # @return [#void]
+    def userdata(data)
+      Qubell::APICall.put("/instances/#{@id}/userData", data)
+    rescue Qubell::ExecutionError
+      raise Qubell::FormatError
+    end
+
+    # Destroy an application
+    # @param [String] force specifies whether the instance should be deleted
+    # @return [#void]
+    def destroy(force = false)
+      status = force ? '1' : '0'
+      begin
+        Qubell::APICall.delete("/instances/#{@id}?#{status}")
+      rescue Qubell::ExecutionError
+        raise Qubell::DestroyError
+      end
+    end
+
+    def instance_of_app?(app)
+      global_info[:applicationId] == app.id
+    end
+
+    %w(version parameters status).each do |method_name|
+      define_method(method_name.to_sym) do
+        global_info[method_name]
+      end
+    end
+
+    private
+
+    def global_info
+      Qubell::APICall.get("/instances/#{@id}")
+    end
+  end
+end

data/lib/qubell/organization.rb

@@ -0,0 +1,26 @@
+# Encoding: utf-8
+# Qubell API wrapper
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+require 'qubell/base'
+require 'qubell/application'
+require 'qubell/environment'
+require 'qubell/api_call'
+
+module Qubell
+  # Implements Qubell organization interface
+  class Organization < Base
+    def applications
+      Qubell::APICall.get("/organizations/#{@id}/applications").map do |app|
+        app['organization_id'] = @id
+        Qubell::Application.new(app)
+      end
+    end
+
+    def environments
+      Qubell::APICall.get("/organizations/#{@id}/environments").map do |app|
+        Qubell::Environment.new(app)
+      end
+    end
+  end
+end

data/lib/qubell/revision.rb

@@ -0,0 +1,12 @@
+require 'qubell/base'
+
+module Qubell
+  # Qubell revision class
+  class Revision < Base
+    def instances
+      Qubell::APICall.get("/revisions/#{id}/instances").map do |instance|
+        Qubell::Instance.new(instance)
+      end
+    end
+  end
+end

data/lib/qubell/version.rb

@@ -0,0 +1,4 @@
+# Main Qubell module
+module Qubell
+  VERSION = '0.0.2'.freeze
+end

data/lib/qubell_api.rb

@@ -0,0 +1,45 @@
+# Encoding: utf-8
+# Qubell API wrapper
+# @author Nikolay Yurin <yurinnick@outlook.com>
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'json'
+require 'base64'
+require 'rest_client'
+
+require 'qubell/base'
+require 'qubell/errors'
+require 'qubell/application'
+require 'qubell/organization'
+require 'qubell/configuration'
+require 'qubell/revision'
+require 'qubell/environment'
+
+# Main Qubell module
+module Qubell
+  # Implements wrapper for Qubell API
+  class API < Base
+    # @param [HashMap<String => String>] key
+    def initialize(options = {})
+      options.each do |key|
+        Qubell.configuration.send("#{key[0]}=", key[1])
+      end
+    end
+
+    # Get list of all organizations that current user belong to.
+    # @return [Array<Qubell::Organization>] organizations info
+    def organizations
+      Qubell::APICall.get('/organizations').map do |org|
+        Qubell::Organization.new(org)
+      end
+    end
+
+    # Get list of instances launched in given environment.
+    # @=irnparam [String] env_id queried environment id
+    # @return [Array<Hash{String => String}>] instances info
+    # def instances(env_id)
+    #   get("/environments/#{env_id}/instances")
+    # end
+  end
+end

data/qubell_api.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qubell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qubell_api'
+  spec.version       = Qubell::VERSION
+  spec.authors       = ['Nikolay Yurin']
+  spec.email         = ['yurinnick@outlook.com']
+  spec.summary       = 'Qubell API wrapper'
+  spec.description   = 'Qubell API wrapper'
+  spec.homepage      = 'https://github.com/yurinnick/qubell-ruby-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{/^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{/^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rest-client', '~> 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11.0'
+  spec.add_development_dependency 'rake', '~> 11.2.0'
+  spec.add_development_dependency 'webmock', '~> 2.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.41.0'
+  spec.add_development_dependency 'yard', '~> 0.9.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.7.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+end