cistern 0.0.3

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 cistern.gemspec
+gemspec

data/LICENSE

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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/cistern.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cistern/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Josh Lane"]
+  gem.email         = ["me@joshualane.com"]
+  gem.description   = %q{API client framework extracted from Fog}
+  gem.summary       = %q{API client framework}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "cistern"
+  gem.require_paths = ["lib"]
+  gem.version       = Cistern::VERSION
+
+  gem.add_dependency "formatador"
+end

data/lib/cistern.rb

@@ -0,0 +1,22 @@
+require 'cistern/version'
+require 'formatador'
+
+module Cistern
+  Error = Class.new(StandardError)
+
+  require 'cistern/hash'
+  require 'cistern/mock'
+  require 'cistern/wait_for'
+  require 'cistern/attributes'
+  require 'cistern/collection'
+  require 'cistern/model'
+  require 'cistern/service'
+
+  def self.timeout=(timeout)
+    @timeout= timeout
+  end
+
+  def self.timeout
+    @timeout || 0
+  end
+end

data/lib/cistern/attributes.rb

@@ -0,0 +1,203 @@
+module Cistern
+  module Attributes
+    module ClassMethods
+
+      def _load(marshalled)
+        new(Marshal.load(marshalled))
+      end
+
+      def aliases
+        @aliases ||= {}
+      end
+
+      def attributes
+        @attributes ||= []
+      end
+
+      def attribute(name, options = {})
+        class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}
+            attributes[:#{name}]
+          end
+          EOS
+        case options[:type]
+        when :boolean
+          class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}=(new_#{name})
+            attributes[:#{name}] = case new_#{name}
+            when true,'true'
+              true
+            when false,'false'
+              false
+            end
+          end
+          EOS
+        when :float
+          class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}=(new_#{name})
+            attributes[:#{name}] = new_#{name} && new_#{name}.to_f
+          end
+          EOS
+        when :integer
+          class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}=(new_#{name})
+            attributes[:#{name}] = new_#{name} && new_#{name}.to_i
+          end
+          EOS
+        when :string
+          class_eval <<-EOS, __FILE__, __LINE__
+          def #{name}=(new_#{name})
+            attributes[:#{name}] = new_#{name} && new_#{name}.to_s
+          end
+          EOS
+        when :time
+          class_eval <<-EOS, __FILE__, __LINE__
+            def #{name}=(new_#{name})
+              attributes[:#{name}] = if new_#{name}.nil? || new_#{name} == "" || new_#{name}.is_a?(Time)
+                new_#{name}
+              else
+                Time.parse(new_#{name})
+              end
+            end
+          EOS
+        when :array
+          class_eval <<-EOS, __FILE__, __LINE__
+            def #{name}=(new_#{name})
+              attributes[:#{name}] = [*new_#{name}]
+            end
+          EOS
+        else
+          if squash = options[:squash]
+            class_eval <<-EOS, __FILE__, __LINE__
+            def #{name}=(new_data)
+              if new_data.is_a?(::Hash)
+                if new_data.has_key?(:'#{squash}')
+                  attributes[:#{name}] = new_data[:'#{squash}']
+                elsif new_data.has_key?("#{squash}")
+                  attributes[:#{name}] = new_data["#{squash}"]
+                else
+                  attributes[:#{name}] = [ new_data ]
+                end
+              else
+                attributes[:#{name}] = new_data
+              end
+            end
+            EOS
+          else
+            class_eval <<-EOS, __FILE__, __LINE__
+              def #{name}=(new_#{name})
+                attributes[:#{name}] = new_#{name}
+              end
+            EOS
+          end
+        end
+        @attributes ||= []
+        @attributes |= [name]
+        for new_alias in [*options[:aliases]]
+          aliases[new_alias] = name
+        end
+      end
+
+      def identity(name, options = {})
+        @identity = name
+        self.attribute(name, options)
+      end
+
+      def ignore_attributes(*args)
+        @ignored_attributes = args
+      end
+
+      def ignored_attributes
+        @ignored_attributes ||= []
+      end
+
+    end
+
+    module InstanceMethods
+
+      def _dump(level)
+        Marshal.dump(attributes)
+      end
+
+      def attributes
+        @attributes ||= {}
+      end
+
+      def dup
+        copy = super
+        copy.dup_attributes!
+        copy
+      end
+
+      def identity
+        send(self.class.instance_variable_get('@identity'))
+      end
+
+      def identity=(new_identity)
+        send("#{self.class.instance_variable_get('@identity')}=", new_identity)
+      end
+
+      def merge_attributes(new_attributes = {})
+        for key, value in new_attributes
+          unless self.class.ignored_attributes.include?(key)
+            if aliased_key = self.class.aliases[key]
+              send("#{aliased_key}=", value)
+            elsif self.respond_to?("#{key}=",true)
+              send("#{key}=", value)
+            else
+              attributes[key] = value
+            end
+          end
+        end
+        self
+      end
+
+      def new_record?
+        !identity
+      end
+
+      # check that the attributes specified in args exist and is not nil
+      def requires(*args)
+        missing = missing_attributes(args)
+        if missing.length == 1
+          raise(ArgumentError, "#{missing.first} is required for this operation")
+        elsif missing.any?
+          raise(ArgumentError, "#{missing[0...-1].join(", ")} and #{missing[-1]} are required for this operation")
+        end
+      end
+
+      def requires_one(*args)
+        missing = missing_attributes(args)
+        if missing.length == args.length
+          raise(ArgumentError, "#{missing[0...-1].join(", ")} or #{missing[-1]} are required for this operation")
+        end
+      end
+
+      protected
+
+      def missing_attributes(args)
+        missing = []
+        for arg in [:connection] | args
+          unless send("#{arg}") || attributes.has_key?(arg)
+            missing << arg
+          end
+        end
+        missing
+      end
+
+      def dup_attributes!
+        @attributes = @attributes.dup
+      end
+
+      private
+
+      def remap_attributes(attributes, mapping)
+        for key, value in mapping
+          if attributes.key?(key)
+            attributes[value] = attributes.delete(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cistern/collection.rb

@@ -0,0 +1,122 @@
+class Cistern::Collection < Array
+  extend Cistern::Attributes::ClassMethods
+  include Cistern::Attributes::InstanceMethods
+
+  Array.public_instance_methods(false).each do |method|
+    unless [:reject, :select, :slice].include?(method.to_sym)
+      class_eval <<-EOS, __FILE__, __LINE__
+        def #{method}(*args)
+          unless @loaded
+            lazy_load
+          end
+          super
+        end
+      EOS
+    end
+  end
+
+  %w[reject select slice].each do |method|
+    class_eval <<-EOS, __FILE__, __LINE__
+      def #{method}(*args)
+        unless @loaded
+          lazy_load
+        end
+        data = super
+        self.clone.clear.concat(data)
+      end
+    EOS
+  end
+
+  def self.model(new_model=nil)
+    if new_model == nil
+      @model
+    else
+      @model = new_model
+    end
+  end
+
+  def initialize(attributes = {})
+    @loaded = false
+    merge_attributes(attributes)
+  end
+
+  def create(attributes={})
+    model = self.new(attributes)
+    model.save
+  end
+
+  def get(identity)
+    raise NotImplementedError
+  end
+
+  def clear
+    @loaded = true
+    super
+  end
+
+  def model
+    self.class.instance_variable_get('@model')
+  end
+
+  attr_accessor :connection
+
+  def new(attributes = {})
+    unless attributes.is_a?(::Hash)
+      raise(ArgumentError.new("Initialization parameters must be an attributes hash, got #{attributes.class} #{attributes.inspect}"))
+    end
+    model.new(
+      attributes.merge(
+        :collection => self,
+        :connection => connection
+      )
+    )
+  end
+
+  def load(objects)
+    clear
+    for object in objects
+      self << new(object)
+    end
+    self
+  end
+
+  def inspect
+    Thread.current[:formatador] ||= Formatador.new
+    data = "#{Thread.current[:formatador].indentation}<#{self.class.name}\n"
+    Thread.current[:formatador].indent do
+      unless self.class.attributes.empty?
+        data << "#{Thread.current[:formatador].indentation}"
+        data << self.class.attributes.map {|attribute| "#{attribute}=#{send(attribute).inspect}"}.join(",\n#{Thread.current[:formatador].indentation}")
+        data << "\n"
+      end
+      data << "#{Thread.current[:formatador].indentation}["
+      unless self.empty?
+        data << "\n"
+        Thread.current[:formatador].indent do
+          data << self.map {|member| member.inspect}.join(",\n")
+          data << "\n"
+        end
+        data << Thread.current[:formatador].indentation
+      end
+      data << "]\n"
+    end
+    data << "#{Thread.current[:formatador].indentation}>"
+    data
+  end
+
+  def reload
+    clear
+    lazy_load
+    self
+  end
+
+  def table(attributes = nil)
+    Formatador.display_table(self.map {|instance| instance.attributes}, attributes)
+  end
+
+  private
+
+  def lazy_load
+    self.all
+  end
+end

data/lib/cistern/hash.rb

@@ -0,0 +1,7 @@
+class Cistern::Hash
+  def self.slice(hash, *keys)
+    {}.tap do |sliced|
+      keys.each{|k| sliced[k]= hash[k] if hash.key?(k)}
+    end
+  end
+end

data/lib/cistern/mock.rb

@@ -0,0 +1,15 @@
+module Cistern
+  class Mock
+    def self.not_implemented
+      raise NotImplementedError
+    end
+
+    def self.random_hex(length)
+      rand(('f' * length).to_i(16)).to_s(16).rjust(length, '0')
+    end
+
+    def self.random_numbers(length)
+      rand(('9' * length).to_i).to_s
+    end
+  end
+end

data/lib/cistern/model.rb

@@ -0,0 +1,61 @@
+class Cistern::Model
+  extend Cistern::Attributes::ClassMethods
+  include Cistern::Attributes::InstanceMethods
+
+  attr_accessor :collection, :connection
+
+  def initialize(attributes={})
+    merge_attributes(attributes)
+  end
+
+  def inspect
+    Thread.current[:formatador] ||= Formatador.new
+    data = "#{Thread.current[:formatador].indentation}<#{self.class.name}"
+    Thread.current[:formatador].indent do
+      unless self.class.attributes.empty?
+        data << "\n#{Thread.current[:formatador].indentation}"
+        data << self.class.attributes.map {|attribute| "#{attribute}=#{send(attribute).inspect}"}.join(",\n#{Thread.current[:formatador].indentation}")
+      end
+    end
+    data << "\n#{Thread.current[:formatador].indentation}>"
+    data
+  end
+
+
+  def save
+    raise NotImplementedError
+  end
+
+  def reload
+    requires :identity
+
+    if data = collection.get(identity)
+      new_attributes = data.attributes
+      merge_attributes(new_attributes)
+      self
+    end
+  end
+
+  def ==(comparison_object)
+    comparison_object.equal?(self) ||
+      (comparison_object.is_a?(self.class) && 
+       comparison_object.identity == self.identity && 
+       !comparison_object.new_record?)
+  end
+
+  def wait_for(timeout=Cistern.timeout, interval=1, &block)
+    reload
+    retries = 3
+    Cistern.wait_for(timeout, interval) do
+      if reload
+        retries = 3
+      elsif retries > 0
+        retries -= 1
+        sleep(1)
+      elsif retries == 0
+        raise Cistern::Error.new("Reload failed, #{self.class} #{self.identity} went away.") # FIXME: pretty much assumes you are calling #ready?
+      end
+      instance_eval(&block)
+    end
+  end
+end

data/lib/cistern/service.rb

@@ -0,0 +1,148 @@
+class Cistern::Service
+  def self.mock!;   @mocking= true; end
+  def self.mocking?; @mocking; end
+  def self.unmock!; @mocking= false; end
+  module Collections
+
+    def collections
+      service.collections
+    end
+
+    def mocked_requests
+      service.mocked_requests
+    end
+
+    def requests
+      service.requests
+    end
+
+  end
+  class << self
+    def inherited(klass)
+      klass.class_eval <<-EOS, __FILE__, __LINE__
+        module Collections
+          include Cistern::Service::Collections
+
+          def service
+            #{klass.name}
+          end
+        end
+        def self.service
+          #{klass.name}
+        end
+      EOS
+    end
+    def model_path(model_path)
+      @model_path = model_path
+    end
+
+    def request_path(request_path)
+      @request_path = request_path
+    end
+
+    def collections
+      @collections ||= []
+    end
+
+    def models
+      @models ||= []
+    end
+
+    def recognized_arguments
+      @recognized_arguments ||= []
+    end
+
+    def required_arguments
+      @required_arguments ||= []
+    end
+
+    def requests
+      @requests ||= []
+    end
+
+    def requires(*args)
+      self.required_arguments.concat(args)
+    end
+
+    def recognizes(*args)
+      self.recognized_arguments.concat(args)
+    end
+
+    def model(model_name)
+      models << model_name
+    end
+
+    def mocked_requests
+      @mocked_requests ||= []
+    end
+
+    def request(request_name)
+      requests << request_name
+    end
+
+    def collection(collection_name)
+      collections << collection_name
+    end
+
+    def validate_options(options={})
+      required_options = Cistern::Hash.slice(options, *required_arguments)
+      missing_required_options = required_arguments - required_options.keys
+      unless missing_required_options.empty?
+        raise "Missing required options: #{missing_required_options.inspect}"
+      end
+      recognized_options = Cistern::Hash.slice(options, *(required_arguments + recognized_arguments))
+      unrecognized_options = options.keys - (required_arguments + recognized_arguments)
+      unless unrecognized_options.empty?
+        raise "Unrecognized options: #{unrecognized_options.inspect}"
+      end
+    end
+
+    def setup_requirements
+      @required ||= false
+      unless @required
+        models.each do |model|
+          require File.join(@model_path, model.to_s)
+        end
+        requests.each do |request|
+          require File.join(@request_path, request.to_s)
+          if service::Mock.method_defined?(request)
+            mocked_requests << request
+          else
+            service::Mock.module_eval <<-EOS, __FILE__, __LINE__
+              def #{request}(*args)
+                Cistern::Mock.not_implemented
+              end
+            EOS
+          end
+        end
+        collections.each do |collection|
+          require File.join(@model_path, collection.to_s)
+          class_name = collection.to_s.split("_").map(&:capitalize).join
+          self.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
+            def #{collection}(attributes={})
+              #{service}::#{class_name}.new({connection: self}.merge(attributes))
+            end
+          EOS
+        end
+        @required = true
+      end
+    end
+
+    def new(options={})
+      validate_options(options)
+      setup_requirements
+
+      if self.mocking?
+        self.const_get(:Mock).send(:include, self.const_get(:Collections))
+        self.const_get(:Mock).new(options)
+      else
+        self.const_get(:Real).send(:include, self.const_get(:Collections))
+        self.const_get(:Real).new(options)
+      end
+    end
+
+    def reset!
+      self.const_get(:Mock).reset!
+    end
+  end
+end

data/lib/cistern/version.rb

@@ -0,0 +1,3 @@
+module Cistern
+  VERSION = "0.0.3"
+end

data/lib/cistern/wait_for.rb

@@ -0,0 +1,15 @@
+module Cistern
+  def self.wait_for(timeout=Cistern.timeout, interval=1, &block)
+    duration = 0
+    start = Time.now
+    until yield || duration > timeout
+      sleep(interval.to_f)
+      duration = Time.now - start
+    end
+    if duration > timeout
+      false
+    else
+      { :duration => duration }
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: cistern
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Josh Lane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client framework extracted from Fog
+email:
+- me@joshualane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cistern.gemspec
+- lib/cistern.rb
+- lib/cistern/attributes.rb
+- lib/cistern/collection.rb
+- lib/cistern/hash.rb
+- lib/cistern/mock.rb
+- lib/cistern/model.rb
+- lib/cistern/service.rb
+- lib/cistern/version.rb
+- lib/cistern/wait_for.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: API client framework
+test_files: []