otc-sdk-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e49f1cdfc253705ff4cfd2451d9c549231c22117
+  data.tar.gz: 0923621decd28b4ea3dd86a2d73b3894673fe822
+SHA512:
+  metadata.gz: a7dcd38f9bc15511540a6d0ec02a8149ce1a1d6a6fecaf51dce606d238c1c408870cd598604ae6e337fae7bec187ea943e49d3aaa0332bf86da291ba1c5764c7
+  data.tar.gz: c7e10437c061bd2dee955b8eec35b758a9acf87e2fadbbe78b261593e45fceedefe1c4965eb850303d4e0a9fbcc460a49d2cb52035f01f3d2a54a30c3a6238aa

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,70 @@
+# Open Telekom Cloud SDK for Ruby
+![Build Status](https://travis-ci.org/streetspotr/otc-sdk-ruby.svg?branch=master)
+
+This is a small SDK which wraps the Open Telekom Cloud API. It currently supports only a limited amount of functionalities.
+
+## Configuration
+
+The only way to currently authenticate with this library is via a user token. To obtain a token the API requires several credentials.
+
+- IAM username
+- IAM password
+- domainname (can be copied from the "My Credential" screen)
+- project ID (can be copied from the "My Credential" screen)
+- region of the project
+
+```
+Otc::Configuration.configure do |config|
+  config.username = "testuser"
+  config.password = "test1234"
+  config.domainname = "OTC-EU-DE-001"
+  config.project = "41234123"
+  config.region = "eu-de"
+end
+```
+
+## General
+
+All responses are wrapped by objects that hold their information via method accessors. Example:
+
+    ecs = Otc::ECS.query_one
+    ecs.name # => "cool-server"
+
+Some information is cached for improved performance using memoization and is therefore not updated on subsequent calls.
+
+## Auto Scaling
+
+### Querying
+
+    Otc::ASGroup.query_all                           # get all auto scaling groups
+    Otc::ASGroup.query_all(name: "my_scaling_group") # get all auto scaling groups filtered by the given name
+    Otc::ASGroup.query_one                           # get the first auto scaling group
+    Otc::ASGroup.query_one(name: "my_scaling_group") # get the first auto scaling group filtered by the given name
+    
+    # convenience methods
+    group = Otc::ASGroup.query_one(name: "my_scaling_group") # => #<Otc::ASGroup>
+    group.instances                                          # get all instances of the auto scaling group
+
+## EIP
+
+### Querying
+
+    Otc::EIP.query_all # get all EIPs
+
+## ECS
+
+### Querying
+
+    Otc::ECS.query_all                    # get all ecs
+    Otc::ECS.query_all(name: "my_server") # get all ecs filtered by the given name
+    Otc::ECS.query_one                    # get the first ecs
+    Otc::ECS.query_one(name: "my_server") # get the first ecs filtered by the given name
+    
+    # convenience methods
+    ecs = Otc::ECS.query_one # => #<Otc::ECS>
+    ecs.public_ip            # => "160.44.232.150"
+
+## Known Issues
+
+- The API uses a limit for nearly every API request but the SDK does not support limits at the moment, so most `query_all` methods won't return all results.
+- Obtaining the public IP address of an ECS instance is rather cumbersome. There might be a better possibility than comparing the private IP of the ECS instance to the private IP of all EIPs.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "otc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/lib/otc/asgroup.rb

@@ -0,0 +1,35 @@
+require "hashie"
+
+module Otc
+  class ASGroup < Hashie::Dash
+    class << self
+      def query_all(name: nil)
+        response = Request.get service: "as", path: "/autoscaling-api/v1/#{Configuration.project!}/scaling_group?scaling_group_name=#{name}"
+        JSON.parse(response.body)["scaling_groups"].map do |group|
+          ASGroup.new(group)
+        end
+      end
+
+      def query_one(name: nil)
+        query_all(name: name).first
+      end
+    end
+
+    [
+      "networks", "detail", "notifications", "scaling_group_name", "scaling_group_id", "scaling_group_status",
+      "scaling_configuration_id", "scaling_configuration_name", "current_instance_number", "desire_instance_number",
+      "min_instance_number", "max_instance_number", "cool_down_time", "lb_listener_id", "lbaas_listeners",
+      "cloud_location_id", "available_zones", "security_groups", "create_time", "vpc_id", "health_periodic_audit_method",
+      "health_periodic_audit_time", "instance_terminate_policy", "is_scaling", "delete_publicip"
+    ].each { |prop| property prop }
+
+    def instances
+      @_instances ||= begin
+        response = Request.get service: "as", path: "/autoscaling-api/v1/#{Configuration.project!}/scaling_group_instance/#{self.scaling_group_id}/list"
+        JSON.parse(response.body)["scaling_group_instances"].map do |group|
+          ASGroupInstance.new(group)
+        end
+      end
+    end
+  end
+end

data/lib/otc/asgroup_instance.rb

@@ -0,0 +1,10 @@
+require "hashie"
+
+module Otc
+  class ASGroupInstance < Hashie::Dash
+    [
+      "instance_id", "scaling_group_id", "scaling_group_name", "life_cycle_state", "health_status",
+      "scaling_configuration_name", "scaling_configuration_id", "create_time", "instance_name"
+    ].each { |prop| property prop }
+  end
+end

data/lib/otc/configuration.rb

@@ -0,0 +1,39 @@
+module Otc
+  class Configuration
+    class MissingError < RuntimeError; end
+
+    class << self
+      attr_accessor :project, :username, :password, :region, :domainname
+
+      def configure
+        yield self
+      end
+
+      def reset
+        @project = nil
+        @username = nil
+        @password = nil
+        @region = nil
+        @domainname = nil
+      end
+
+      def method_missing(m, *args, &block)
+        m_as_string = m.to_s
+
+        if m_as_string.end_with?("!")
+          method = m_as_string.split("!").first.to_sym
+
+          if self.respond_to?(method)
+            send(method).tap do |result|
+              raise MissingError, "missing configuration #{method}" if result.nil?
+            end
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/otc/ecs.rb

@@ -0,0 +1,39 @@
+require "hashie"
+
+module Otc
+  class ECS < Hashie::Dash
+    class << self
+      def query_all(name: nil)
+        response = Request.get service: "ecs", path: "/v2/#{Configuration.project!}/servers/detail?name=#{name}"
+        JSON.parse(response.body)["servers"].map do |server|
+          keys_to_delete = server.keys - ECS::ATTRIBUTES
+          keys_to_delete.each { |key| server.delete(key) }
+
+          ECS.new(server)
+        end
+      end
+
+      def query_one(name: nil)
+        query_all(name: name).first
+      end
+    end
+
+    ATTRIBUTES = [
+      "name", "id", "status", "created", "updated", "flavor", "image", "tenant_id", "key_name", 
+      "user_id", "metadata", "hostId", "addresses", "security_groups", "tags", "links", "progress"
+    ]
+
+    ATTRIBUTES.each { |prop| property prop }
+
+    def public_ip
+      @_public_ip ||= begin
+        private_addresses = self.addresses.values.flatten.map { |val| val["addr"] }
+
+        eip = EIP.query_all.select { |ip| private_addresses.include?(ip.private_ip_address) }.first
+        if eip
+          eip.public_ip_address
+        end
+      end
+    end
+  end
+end

data/lib/otc/eip.rb

@@ -0,0 +1,19 @@
+require "hashie"
+
+module Otc
+  class EIP < Hashie::Dash
+    class << self
+      def query_all
+        response = Request.get service: "ecs", path: "/v1/#{Configuration.project!}/publicips"
+        JSON.parse(response.body)["publicips"].map do |ip|
+          EIP.new(ip)
+        end
+      end
+    end
+
+    [
+      "id", "status", "type", "port_id", "public_ip_address", "private_ip_address",
+      "tenant_id", "create_time", "bandwidth_id", "bandwidth_share_type", "bandwidth_size"
+    ].each { |prop| property prop }
+  end
+end

data/lib/otc/request.rb

@@ -0,0 +1,74 @@
+require "net/http"
+require "json"
+
+module Otc
+  class Request
+    class UnauthorizedError < RuntimeError; end
+    class ApiError < RuntimeError; end
+
+    class << self
+      def base_uri(service:, path:)
+        "https://#{service}.#{Configuration.region!}.otc.t-systems.com#{path}"
+      end
+
+      # returns the token if it is still valid (not older than 20 hours)
+      # else obtains a new token
+      def token
+        latest_timestamp = @_token ? @_token[:timestamp] : nil
+        twenty_hours = 20 * 60 * 60
+
+        if latest_timestamp.nil? || latest_timestamp < (Time.now - twenty_hours).to_i
+          body = {
+            auth: {
+              identity: {
+                methods: ["password"],
+                password: {
+                  user: {
+                    name: Configuration.username!,
+                    password: Configuration.password!,
+                    domain: { name: Configuration.domainname! }
+                  }
+                }
+              },
+              scope: {
+                project: { id: Configuration.project! }
+              }
+            }
+          }
+
+          response = post(service: "iam", path: "/v3/auth/tokens", body: body.to_json)
+
+          @_token = {
+            token: response.fetch("X-Subject-Token"),
+            timestamp: Time.now.to_i
+          }
+        end
+
+        @_token.fetch(:token)
+      end
+
+      def get(service:, path:, authenticated_request: true)
+        uri = URI.parse(base_uri(service: service, path: path))
+        headers = { "X-Auth-Token" => token } if authenticated_request
+        req = Net::HTTP::Get.new(uri.request_uri, headers)
+        send(req, uri)
+      end
+
+      def post(service:, path:, body:)
+        uri = URI.parse(base_uri(service: service, path: path))
+        req = Net::HTTP::Post.new(uri.request_uri, "Content-Type" => "application/json;charset=utf8")
+        req.body = body
+        send(req, uri)
+      end
+
+      def send(req, uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.request(req).tap do |response|
+          raise UnauthorizedError, "could not authorize request" if response.code == "401"
+          raise ApiError, "error during api call: #{response.body}" if response.code.to_i >= 300
+        end
+      end
+    end
+  end
+end

data/lib/otc/version.rb

@@ -0,0 +1,3 @@
+module Otc
+  VERSION = "0.1.0"
+end

data/lib/otc.rb

@@ -0,0 +1,10 @@
+require "otc/version"
+require "otc/configuration"
+require "otc/request"
+require "otc/asgroup"
+require "otc/asgroup_instance"
+require "otc/eip"
+require "otc/ecs"
+
+module Otc
+end

data/otc-sdk-ruby.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "otc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "otc-sdk-ruby"
+  spec.version       = Otc::VERSION
+  spec.authors       = ["Streetspotr GmbH"]
+  spec.email         = ["devs@streetspotr.com"]
+
+  spec.summary       = %q{Ruby SDK which wraps the open telekom cloud API}
+  spec.homepage      = "https://github.com/streetspotr/otc-sdk-ruby"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "hashie"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: otc-sdk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Streetspotr GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: 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: 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: rake
+  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'
+description: 
+email:
+- devs@streetspotr.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- lib/otc.rb
+- lib/otc/asgroup.rb
+- lib/otc/asgroup_instance.rb
+- lib/otc/configuration.rb
+- lib/otc/ecs.rb
+- lib/otc/eip.rb
+- lib/otc/request.rb
+- lib/otc/version.rb
+- otc-sdk-ruby.gemspec
+homepage: https://github.com/streetspotr/otc-sdk-ruby
+licenses: []
+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: Ruby SDK which wraps the open telekom cloud API
+test_files: []