stacktor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7d9fb1b2d3e7ed6030c1dbe01e5c1b25e25a3ec
+  data.tar.gz: 391609f9697ddba50c6df80e20a175ba40e74397
+SHA512:
+  metadata.gz: 83a19c0415ddd2fc15292bcd7c7e23d60c4cd8fa9842bd94095865ad43cdf32ff0d1c4bd771568fe5f3f052e12ce16ec3c3537ababa477aafe43076b07cf6aab
+  data.tar.gz: 97004fc01eb339a298d002d7ab8fe854f75dd86c13d44e8e9dff45eaeac815fbb026cda67c89a1808b0873dad50299560ab277b57bf89336ab23a3cc988341de

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 TODO: Write your name
+
+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,29 @@
+# Stacktor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stacktor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stacktor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/stacktor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/stacktor/core/client.rb

@@ -0,0 +1,51 @@
+module Stacktor
+
+  module Core
+
+    class Client
+
+      def initialize(options={})
+        @settings = options
+      end
+
+      def settings
+        @settings
+      end
+
+      def before_request(&block)
+        @before_request_fn = block
+      end
+
+      def url
+        @settings[:url]
+      end
+
+      def url=(val)
+        @settings[:url] = val
+      end
+
+      ##
+      # Executes request, running any handlers beforehand
+      # and setting headers as necessary
+      #
+      # params:
+      #   req - request to process
+      def execute_request(opts)
+        if !@before_request_fn.nil?
+          @before_request_fn.call(opts, self)
+        end
+        opts[:url] = self.url + opts[:path]
+        opts[:headers] = build_headers.merge( (opts[:headers] || {}) )
+        req = Request.new(opts)
+        resp = req.execute
+      end
+
+      def build_headers
+        {}
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/core/request.rb

@@ -0,0 +1,116 @@
+require 'net/http'
+
+module Stacktor
+
+  module Core
+
+    class Request
+
+      def self.connection_for(uri)
+        @connections ||= {}
+
+        host = uri.host
+        port = uri.port
+        secure = uri.scheme == 'https'
+
+        if @connections[ [host, port, secure] ].nil?
+          c = Net::HTTP.new(host, port)
+          c.use_ssl = secure
+          c.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          c.start
+          @connections[ [host, port, secure] ] = c
+        else
+          c = @connections[ [host, port, secure] ]
+        end
+        return c
+      end
+
+      def initialize(opts)
+        @options = opts
+      end
+
+      def options
+        @options
+      end
+
+      def url
+        @options[:url]
+      end
+      def method
+        @options[:method]
+      end
+      def headers
+        @options[:headers]
+      end
+      def data
+        @options[:data]
+      end
+      def response=(resp)
+        @resp = resp
+      end
+      def response
+        @resp
+      end
+      def do_stream_response?
+        !@options[:response_handler].nil?
+      end
+
+      def success?
+        @resp && !@resp.code.match(/^20.$/).nil?
+      end
+
+
+      def execute
+        data = self.data
+        uri = URI(self.url)
+        conn = self.class.connection_for(uri)
+        req_kls = Net::HTTP.const_get(self.method.capitalize)
+        headers = self.headers
+        resp_fn = @options[:response_handler]
+
+        if self.method == "GET"
+          uri.query = data.to_query unless data.nil?
+          req = req_kls.new(uri.request_uri, headers)
+        else
+          data_reg = data_stream = nil
+          if data.is_a?(Hash)
+            data_reg = data.to_json
+          elsif data.respond_to?(:read)
+            data_stream = data
+            headers['Content-Length'] = data.size.to_s
+          else
+            data_reg = data
+          end
+          req = req_kls.new(uri.path, headers)
+          req.body_stream = data_stream unless data_stream.nil?
+          req.body = data_reg unless data_reg.nil?
+        end
+        if resp_fn.nil?
+          @resp = conn.request(req)
+        else
+          @resp = conn.request(req) do |r|
+            r.read_body do |bytes|
+              resp_fn.call(bytes)
+            end
+          end
+        end
+        return self.to_response_hash
+      end
+
+      def to_response_hash
+        return nil if @resp.nil?
+        success = self.success?
+        ret = {success: success, code: @resp.code, request: self, response: @resp}
+        if self.do_stream_response? && success
+          ret[:body] = nil
+        else
+          ret[:body] = @resp.body
+        end
+        return ret
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/core/resource.rb

@@ -0,0 +1,42 @@
+module Stacktor
+
+  module Core
+
+    class Resource
+
+      attr_accessor :data, :client
+
+      def initialize(data, client, opts={})
+        @client = client
+        self.handle_data(data, opts)
+      end
+
+      def handle_data(data, opts={})
+        if data.is_a?(String)
+          data = JSON.parse(data)
+        end
+        @data = data || {}
+        @options = opts
+        @options[:headers] ||= {}
+      end
+
+      def [](field)
+        @data[field.to_s] || @options[:headers][field.to_s]
+      end
+      def []=(field,val)
+        @data[field.to_s]=val
+      end
+
+      def headers
+        @options[:headers]
+      end
+
+      def method_missing(method, *args, &block)
+        return self[method]
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/identity/v2/client.rb

@@ -0,0 +1,50 @@
+
+module Stacktor
+
+  module Identity
+
+    module V2
+
+      class Client < Stacktor::Core::Client
+
+        def authenticate_token(opts)
+          path = "/tokens"
+          data = {
+            auth: {
+              tenantId: opts[:tenant_id],
+              passwordCredentials: {
+                username: opts[:username],
+                password: opts[:password]
+              }
+            }
+          }
+          resp = self.execute_request(
+            path: path,
+            method: "POST",
+            data: data
+          )
+          parse_token(resp)
+          return resp
+        end
+
+        private
+
+        def build_headers
+          {
+            'Content-Type' => 'application/json'
+          }
+        end
+
+        def parse_token(resp)
+          if resp[:success]
+            resp[:token] = Token.new(resp[:body], self)
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/identity/v2/token.rb

@@ -0,0 +1,36 @@
+module Stacktor
+
+  module Identity
+
+    module V2
+
+      class Token < Core::Resource
+
+        def id
+          self.data["access"]["token"]["id"]
+        end
+        def expires_at
+          str = self.data["access"]["token"]["expires"]
+          Time.parse(str)
+        end
+        def expired?
+          self.expires_at < Time.now
+        end
+
+        def valid?
+          !self.expired?
+        end
+
+        def endpoint_url_for_service_type(type, level=:public)
+          svc = self.data['access']['serviceCatalog'].select{|s| s['type'] == type}.first
+          return nil if svc.nil?
+          return svc['endpoints'][0]["#{level.to_s}URL"]
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/swift/v1/client.rb

@@ -0,0 +1,128 @@
+module Stacktor
+
+  module Swift
+
+    module V1
+
+      class Client < Stacktor::Core::Client
+
+        def list_containers(opts={})
+          path = "/"
+          opts[:format] = 'json'
+          resp = self.execute_request(
+            path: path,
+            method: "GET",
+            data: opts
+          )
+          parse_containers(resp)
+          return resp
+        end
+
+        ## HELPERS
+
+        def get_object_content(opts, &resp_fn)
+          ctn = opts[:container_name]
+          obn = opts[:object_name]
+
+          resp = self.execute_request(
+            path: "/#{ctn}/#{obn}",
+            method: "GET",
+            response_handler: resp_fn
+          )
+          parse_object(resp, {'name' => obn, 'container_name' => ctn})
+          return resp
+        end
+
+        def create_object(opts)
+          ctn = opts[:container_name]
+          obn = opts[:object_name]
+          if opts[:content].is_a?(String)
+            body = StringIO.new(opts[:content])
+          else
+            body = opts[:content]
+          end
+
+          headers = {}
+          if opts[:content_type].nil?
+            headers['X-Detect-Content-Type'] = 'true'
+          else
+            headers['Content-Type'] = opts[:content_type]
+          end
+          if !opts[:metadata].nil?
+            opts[:metadata].each do |k,v|
+              headers["X-Object-Meta-#{k}"] = v
+            end
+          end
+          resp = self.execute_request(
+            path: "/#{ctn}/#{obn}",
+            method: "PUT",
+            headers: headers,
+            data: body
+          )
+          parse_object(resp, {'name' => obn, 'container_name' => ctn})
+          resp[:object].reload if resp[:object]
+          return resp
+        end
+
+        def delete_object(opts)
+          ctn = opts[:container_name]
+          obn = opts[:object_name]
+
+          resp = self.execute_request(
+            path: "/#{ctn}/#{obn}",
+            method: "DELETE"
+          )
+          parse_object(resp, {'name' => obn, 'container_name' => ctn})
+          return resp
+        end
+
+        def get_object_metadata(opts)
+          ctn = opts[:container_name]
+          obn = opts[:object_name]
+
+          resp = self.execute_request(
+            path: "/#{ctn}/#{obn}",
+            method: "HEAD"
+          )
+          parse_object(resp, {'name' => obn, 'container_name' => ctn})
+          return resp
+        end
+
+        def token=(val)
+          @settings[:token] = val
+        end
+        def token
+          @settings[:token]
+        end
+        def has_valid_token?
+          @settings[:token] && @settings[:token].valid?
+        end
+
+        private
+
+        def parse_containers(resp)
+          if resp[:success]
+            resp[:containers] = JSON.parse(resp[:body]).collect {|c| Container.new(c, self)}
+          end
+        end
+
+        def parse_object(resp, data={})
+          r = resp[:response]
+          if resp[:success]
+            resp[:object] = ContainerObject.new(data, self, headers: r)
+          end
+        end
+
+        def build_headers
+          {
+            'X-Auth-Token' => self.settings[:token].id
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/swift/v1/container.rb

@@ -0,0 +1,15 @@
+module Stacktor
+
+  module Swift
+
+    module V1
+
+      class Container < Core::Resource
+
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/swift/v1/container_object.rb

@@ -0,0 +1,104 @@
+module Stacktor
+
+  module Swift
+
+    module V1
+
+      class ContainerObject < Core::Resource
+
+        def name
+          data['name']
+        end
+
+        def container_name
+          data['container_name']
+        end
+
+        def etag
+          data['hash'] || headers['ETag']
+        end
+
+        def content_length
+          bytes = data['bytes'] || headers['Content-Length']
+          bytes ? bytes.to_i : nil
+        end
+
+        def content_type
+          type = data['content_type'] || headers['Content-Type']
+          return nil if type.nil?
+          return type.split(";").first
+        end
+
+        def last_modified
+          t = data['last_modified'] || headers['Last-Modified']
+          return nil if t.nil?
+          return Time.parse(t)
+        end
+
+        def metadata
+          ret = {}
+          headers.each do |k,v|
+            h = k.downcase.strip
+            if h.start_with?("x-object-meta-")
+              mk = h.split('-').last
+              ret[mk] = v
+            end
+          end
+          return ret
+        end
+
+        ## TRANSACTIONS
+
+        def read
+          result = @client.get_object_content(container_name: self.container_name, object_name: self.name)
+          if result[:success]
+            return result[:body]
+          else
+            raise result[:body]
+          end
+        end
+
+        def stream(&block)
+          result = @client.get_object_content(container_name: self.container_name, object_name: self.name) do |bytes|
+            block.call(bytes)
+          end
+          if result[:success]
+            return result[:body]
+          else
+            raise result[:body]
+          end
+        end
+
+        def write_to_file(path)
+          File.open(path, 'wb') do |fw|
+            self.stream do |bytes|
+              fw.write bytes
+            end
+          end
+        end
+
+        def reload
+          result = @client.get_object_metadata(container_name: self.container_name, object_name: self.name)
+          if result[:success]
+            self.handle_data(result[:body], headers: result[:response])
+          else
+            raise result[:body]
+          end
+        end
+
+        def delete
+          result = @client.delete_object(container_name: self.container_name, object_name: self.name)
+          if result[:success]
+            return result
+          else
+            raise result[:body]
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/stacktor/version.rb

@@ -0,0 +1,3 @@
+module Stacktor
+  VERSION = "1.0.0"
+end

data/lib/stacktor.rb

@@ -0,0 +1,18 @@
+require 'json'
+require 'time'
+require 'active_support/all'
+require 'stringio'
+
+require "stacktor/version"
+require "stacktor/core/request"
+require "stacktor/core/resource"
+require "stacktor/core/client"
+require "stacktor/identity/v2/client"
+require "stacktor/identity/v2/token"
+require "stacktor/swift/v1/client"
+require "stacktor/swift/v1/container"
+require "stacktor/swift/v1/container_object"
+
+module Stacktor
+  # Your code goes here...
+end

data/stacktor.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stacktor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stacktor"
+  spec.version       = Stacktor::VERSION
+  spec.authors       = ["Alan Graham"]
+  spec.email         = ["alan@productlab.com"]
+  spec.summary       = %q{A more structured gem for communicating with OpenStack.}
+  spec.description   = %q{A more structured gem for communicating with OpenStack.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: stacktor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alan Graham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: A more structured gem for communicating with OpenStack.
+email:
+- alan@productlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stacktor.rb
+- lib/stacktor/core/client.rb
+- lib/stacktor/core/request.rb
+- lib/stacktor/core/resource.rb
+- lib/stacktor/identity/v2/client.rb
+- lib/stacktor/identity/v2/token.rb
+- lib/stacktor/swift/v1/client.rb
+- lib/stacktor/swift/v1/container.rb
+- lib/stacktor/swift/v1/container_object.rb
+- lib/stacktor/version.rb
+- stacktor.gemspec
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: A more structured gem for communicating with OpenStack.
+test_files: []