nifcloud 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0afd39ff3b060348389f157e449de337dea88331
+  data.tar.gz: 947d8505cea05bbe0f37a0cb31a4841c4820311b
+SHA512:
+  metadata.gz: b425260f6b0b12f7c8607947de0fc7ae330d3396a91773569dafc2b927077c0a5e980ad9744d0b06ebc467de1ecf4bc73aa56f1baeb291a715c80ed346e1d586
+  data.tar.gz: 9c160e5b1aaff8d118c949aaf673163614e73e24ff64bcb0060a5e2075e507e4c763ad386bc80caa65b1aef46b10ce4f47896b333dde751899ff60d2b4df0222

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+
+.vscode/
+.DS_Store
+
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.yardoc
+
+\.idea/

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}"}
+
+# Specify your gem's dependencies in nifcloud.gemspec
+gemspec

data/README.md

@@ -0,0 +1,21 @@
+# Unofficial NIF Cloud SDK for Ruby
+
+## 概要
+ニフクラ(IaaS)から提供されているAPIを利用し、サーバー作成等の操作を可能にするSDKです。
+
+## インストール
+```
+gem install nifcloud
+```
+
+## 使い方
+```
+$ export NIFCLOUD_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXX
+$ export NIFCLOUD_SECRET_ACCESS_KEY=YYYYYYYYYYYYYYYYYYY
+```
+
+## For Developer
+```
+$ bundle install --path=vendor/bundle
+$ bundle exec rake
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nifcloud"
+
+# 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/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/Instances/DescribeInstances.rb

@@ -0,0 +1,10 @@
+require 'nifcloud'
+require 'pp'
+
+nc = Nifcloud.client(endpoint: 'https://computing.jp-west-1.api.cloud.nifty.com/api', debug: true)
+res = nc.DescribeInstances()
+
+pp res
+
+pp res.reservationSet[0].groupSet[0].groupId
+pp res.reservationSet[0].instancesSet[0].instanceId

data/lib/nifcloud/api.rb

@@ -0,0 +1,14 @@
+module Nifcloud
+  class API < Request
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = Nifcloud.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS + [:secret_key]).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+
+      super
+    end
+  end
+end

data/lib/nifcloud/client/Instances.rb

@@ -0,0 +1,33 @@
+class Nifcloud::Client
+  module Instances
+    def DescribeInstances(options={})
+      options[:Action] = 'DescribeInstances'
+      get('/', query: options)
+    end
+
+    def DescribeInstanceAttribute(options={})
+      options[:Action] = 'DescribeInstanceAttribute'
+      get('/', query: options)
+    end
+
+    def ModifyInstanceAttribute(options={})
+      options[:Action] = 'ModifyInstanceAttribute'
+      get('/', query: options)
+    end
+
+    def RebootInstances(options={})
+      options[:Action] = 'RebootInstances'
+      get('/', query: options)
+    end
+
+    def RunInstances(options={})
+      options[:Action] = 'RunInstances'
+      get('/', query: options)
+    end
+
+    def StartInstances(options={})
+      options[:Action] = 'StartInstances'
+      get('/', query: options)
+    end
+  end
+end

data/lib/nifcloud/client.rb

@@ -0,0 +1,27 @@
+module Nifcloud
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each {|f| require f}
+
+    include Instances
+
+    def inspect
+      inspected = super
+
+      if @secret_key
+        inspected = inspected.sub! @secret_key, only_show_last_four_chars(@secret_key)
+      end
+
+      if @access_key
+        inspected = inspected.sub! @access_key, only_show_last_four_chars(@access_key)
+      end
+
+      inspected
+    end
+
+    private
+
+    def only_show_last_four_chars(key)
+      "#{'*'*(key.size - 4)}#{key[-4..-1]}"
+    end
+  end
+end

data/lib/nifcloud/configuration.rb

@@ -0,0 +1,30 @@
+module Nifcloud
+  module Configuration
+    VALID_OPTIONS_KEYS = [:endpoint, :secret_key, :access_key, :user_agent, :debug].freeze
+    DEFAULT_USER_AGENT = "Nifcloud Ruby Gem #{Nifcloud::VERSION}".freeze
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def reset
+      self.endpoint = ENV['NIFCLOUD_API_ENDPOINT']
+      self.secret_key = ENV['NIFCLOUD_API_SECRET_KEY']
+      self.access_key = ENV['NIFCLOUD_API_ACCESS_KEY']
+      self.debug = nil
+      self.user_agent = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/nifcloud/error.rb

@@ -0,0 +1,96 @@
+module Nifcloud
+  module Error
+    # Custom error class for rescuing from all errors.
+    class Error < StandardError;
+    end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error;
+    end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error;
+    end
+
+    # Custom error class for rescuing from HTTP response errors.
+    class ResponseError < Error
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      # Status code returned in the http response.
+      #
+      # @return [Integer]
+      def response_status
+        (@response != false) ? @response.Code : "?"
+      end
+
+      private
+
+      # Human friendly message.
+      #
+      # @return [String]
+      def build_error_message
+        message = @response.Message if @response != false
+        message = "false" if @response == false
+
+        "Server responded with code #{@response.Code}, \n message: #{handle_message(message)}. \n\n"
+      end
+
+      # Handle error response message in case of nested hashes
+      def handle_message(message)
+        case message
+          #when Nifcloud::ObjectifiedHash
+          #  message.to_h.sort.map do |key, val|
+          #    "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
+          #  end.join(', ')
+          when Array
+            message.join(' ')
+          else
+            message
+        end
+      end
+    end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < ResponseError;
+    end
+  end
+end

data/lib/nifcloud/objectified_hash.rb

@@ -0,0 +1,29 @@
+module Nifcloud
+  module ObjectifiedHash
+    def method_missing(meth, *args, &block)
+      if args.size == 0
+        obj = self[meth.to_s] || self[meth.to_sym]
+        if obj.is_a?(Hash) and obj.has_key?('item')
+          obj['item'].each do |i|
+            i.extend ObjectifiedHash
+          end
+          obj['item']
+        else
+          obj.extend ObjectifiedHash
+        end
+      end
+    end
+
+    def type
+      self['type']
+    end
+
+    def has?(key)
+      self[key] && !self[key].to_s.empty?
+    end
+
+    def does_not_have?(key)
+      self[key].nil? || self[key].to_s.empty?
+    end
+  end
+end

data/lib/nifcloud/request.rb

@@ -0,0 +1,108 @@
+require 'httpclient'
+require 'xmlsimple'
+
+module Nifcloud
+  class Request
+    attr_accessor :secret_key, :access_key, :endpoint
+
+    def initialize(options={})
+      @client = HTTPClient.new default_header: {"User-Agent" => @user_agent}
+      @client.debug_dev = $stderr if @debug
+    end
+
+    def get(path, options={})
+      set_query(options)
+      validate @client.get(@endpoint + path, options)
+    end
+
+    def post(path, options={})
+      set_query(options)
+      validate @client.post(@endpoint + path, options)
+    end
+
+    def put(path, options={})
+      set_query(options)
+      validate @client.put(@endpoint + path, options)
+    end
+
+    def delete(path, options={})
+      set_query(options)
+      validate @client.delete(@endpoint + path, options)
+    end
+
+    def self.set_proxy_config(address=nil, port=nil, username=nil, password=nil)
+      @client.proxy = "http://#{address}:#{port}"
+      @client.set_proxy_auth(username, password) if username
+    end
+
+    private
+
+    def parse(xml)
+      options = {'forcearray' => ['item', 'member'], 'suppressempty' => nil, 'keeproot' => false}
+      body = XmlSimple.xml_in(xml, options)
+
+      if body.is_a? Hash
+        body.extend ObjectifiedHash
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Error::Parsing.new "Couldn't parse a response body"
+      end
+    end
+
+    def validate(response)
+      error_klass =
+          case response.code
+            when 400 then
+              Error::BadRequest
+            when 401 then
+              Error::Unauthorized
+            when 403 then
+              Error::Forbidden
+            when 404 then
+              Error::NotFound
+            when 405 then
+              Error::MethodNotAllowed
+            when 409 then
+              Error::Conflict
+            when 422 then
+              Error::Unprocessable
+            when 500 then
+              Error::InternalServerError
+            when 502 then
+              Error::BadGateway
+            when 503 then
+              Error::ServiceUnavailable
+          end
+
+      response_obj = parse response.body
+      fail error_klass.new(response_obj.Errors.Error) if error_klass
+      response_obj
+    end
+
+    def set_query(options={})
+      set_timestamp(options)
+      set_access_key(options)
+      set_signature(options)
+    end
+
+    def set_timestamp(options)
+      options[:query][:Timestamp] = Time.now.strftime("%Y%m%dT%H:%M:%SZ")
+    end
+
+    def set_access_key(options)
+      options[:query][:AccessKeyId] = access_key
+    end
+
+    def set_signature(options)
+      key = @secret_key
+      data = "#{options[:query][:Action]}#{options[:query][:Timestamp]}"
+      options[:query][:Signature] = Signature.v0(key, data)
+      options[:query][:SignatureVersion] = '0'
+    end
+  end
+end

data/lib/nifcloud/signature.rb

@@ -0,0 +1,15 @@
+require 'openssl'
+require 'base64'
+require 'cgi/util'
+
+module Nifcloud
+  class Signature
+    def self.v0(key, data)
+      Base64.encode64(OpenSSL::HMAC.digest("sha1", key.encode("utf-8"), data.encode("utf-8"))).chomp
+    end
+
+    def self.v2(key, data)
+      CGI.escape(Base64.encode64(OpenSSL::HMAC.digest("sha256", key.encode("utf-8"), data.encode("utf-8"))).chomp)
+    end
+  end
+end

data/lib/nifcloud/version.rb

@@ -0,0 +1,3 @@
+module Nifcloud
+  VERSION = "0.0.2"
+end

data/lib/nifcloud.rb

@@ -0,0 +1,29 @@
+require 'nifcloud/version'
+require 'nifcloud/objectified_hash'
+require 'nifcloud/error'
+require 'nifcloud/signature'
+require 'nifcloud/configuration'
+require 'nifcloud/request'
+require 'nifcloud/api'
+require 'nifcloud/client'
+
+module Nifcloud
+  extend Configuration
+
+  def self.client(options={})
+    Nifcloud::Client.new(options)
+  end
+
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
+    Nifcloud::Request.set_proxy_config(address, port, username, password)
+  end
+end

data/nifcloud.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nifcloud/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "nifcloud"
+  spec.version = Nifcloud::VERSION
+  spec.authors = ["Kazuki Iwata"]
+  spec.email = ["kazu.0516.k0n0f@gmail.com"]
+
+  spec.summary = %q{Unofficial NIFCLOUD SDK for Ruby}
+  spec.description = %q{The Unofficial NIFCLOUD SDK for Ruby}
+  spec.homepage = "https://github.com/kzmake/nifcloud"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) {|f| File.basename(f)}
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_runtime_dependency 'xml-simple'
+  spec.add_runtime_dependency 'httpclient'
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: nifcloud
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kazuki Iwata
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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: xml-simple
+  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: httpclient
+  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: The Unofficial NIFCLOUD SDK for Ruby
+email:
+- kazu.0516.k0n0f@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/Instances/DescribeInstances.rb
+- lib/nifcloud.rb
+- lib/nifcloud/api.rb
+- lib/nifcloud/client.rb
+- lib/nifcloud/client/Instances.rb
+- lib/nifcloud/configuration.rb
+- lib/nifcloud/error.rb
+- lib/nifcloud/objectified_hash.rb
+- lib/nifcloud/request.rb
+- lib/nifcloud/signature.rb
+- lib/nifcloud/version.rb
+- nifcloud.gemspec
+homepage: https://github.com/kzmake/nifcloud
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Unofficial NIFCLOUD SDK for Ruby
+test_files: []