ocs 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6da46759c59ec08d60abe0a7358887705f839e7
-  data.tar.gz: 7217eb402e0296c33ec120894d47d159d29580e1
+  metadata.gz: f8c215e6924e10df79b386df078dc3d8a29b4674
+  data.tar.gz: afef6522a19430d1311ef964dd5abb24fbb6268a
 SHA512:
-  metadata.gz: b3d16cf65976c49fd941791310ef25643c6cf65ffd165a0092d03da4fd9d2d066ed0e112f0a66f29e46867ff1e6ac8dbff4d4f29d0917d3c482fb619d1a0b5b3
-  data.tar.gz: 3eb54aec380a44afc512ec3a8c1eb7af0695b54989fdd15bb62a36a1960140e8c1ab8960513c864128631c24f24d6a2239e204cd57edf9d2887db09c96a613d5
+  metadata.gz: 5bd0b3b9d4bc4ce58a8fba98faa8f15fbad18caa8a22f302b290c49b4f6ab05bae9aa948262130b02b30f917b2abcb380b984739acd035a45f8014caf1a972a6
+  data.tar.gz: dfda45f337a17f60d9011c155023f4ebffbb5cf2ce2e2786ee60074f84f4d0869551c8ddd9b8cfd50d064b13d2786bff3e20af82d0ba495d61db049eb9919861

data/docs/resources.md

@@ -0,0 +1,278 @@
+Resouces
+========
+
+## Account
+### Attributes
+
+Attribute | Type
+---|---
+name | String
+
+## Address
+### Attributes
+
+Attribute | Type
+---|---
+
+## AffinityGroup
+### Attributes
+
+Attribute | Type
+---|---
+
+## AsyncJob
+### Attributes
+
+Attribute | Type
+---|---
+jobid | String
+jobstatus | Integer
+
+## Base
+### Attributes
+
+Attribute | Type
+---|---
+
+## DiskOffering
+### Attributes
+
+Attribute | Type
+---|---
+name | String
+
+## Domain
+### Attributes
+
+Attribute | Type
+---|---
+haschild | [TrueClass, FalseClass]
+level | Integer
+name | String
+path | String
+
+## Group
+### Attributes
+
+Attribute | Type
+---|---
+name | String
+
+## Host
+### Attributes
+
+Attribute | Type
+---|---
+name | String
+
+## Iso
+### Attributes
+
+Attribute | Type
+---|---
+displaytext | String
+name | String
+
+## Network
+### Attributes
+
+Attribute | Type
+---|---
+account | String
+aclid | String
+acltype | String
+broadcastdomaintype | String
+broadcasturi | String
+canusefordeploy | [TrueClass, FalseClass]
+cidr | String
+displaynetwork | [TrueClass, FalseClass]
+displaytext | String
+dns1 | String
+dns2 | String
+gateway | String
+ip6cidr | String
+ip6gateway | String
+isdefault | [TrueClass, FalseClass]
+ispersistent | [TrueClass, FalseClass]
+issystem | [TrueClass, FalseClass]
+name | String
+netmask | String
+networkcidr | String
+networkdomain | String
+networkofferingavailability | String
+networkofferingconservemode | [TrueClass, FalseClass]
+networkofferingdisplaytext | String
+networkofferingid | String
+networkofferingname | String
+physicalnetworkid | String
+related | String
+reservediprange | String
+restartrequired | [TrueClass, FalseClass]
+service | Array
+specifyipranges | [TrueClass, FalseClass]
+state | String
+subdomainaccess | [TrueClass, FalseClass]
+traffictype | String
+type | String
+vlan | String
+vpcid | String
+
+## Nic
+### Attributes
+
+Attribute | Type
+---|---
+broadcasturi | String
+gateway | String
+ipaddress | String
+isdefault | [TrueClass, FalseClass]
+isolationuri | String
+macaddress | String
+netmask | String
+networkid | String
+networkname | String
+traffictype | String
+type | String
+
+## OsType
+### Attributes
+
+Attribute | Type
+---|---
+description | String
+
+## ResourceDetail
+### Attributes
+
+Attribute | Type
+---|---
+type | String
+
+## SecurityGroup
+### Attributes
+
+Attribute | Type
+---|---
+
+## ServiceOffering
+### Attributes
+
+Attribute | Type
+---|---
+cpunumber | Integer
+cpuspeed | Integer
+created | String
+defaultuse | [TrueClass, FalseClass]
+deploymentplanner | String
+diskBytesReadRate | Integer
+diskBytesWriteRate | Integer
+diskIopsReadRate | Integer
+diskIopsWriteRate | Integer
+displaytext | String
+hosttags | String
+iscustomized | [TrueClass, FalseClass]
+issystem | [TrueClass, FalseClass]
+isvolatile | [TrueClass, FalseClass]
+limitcpuuse | [TrueClass, FalseClass]
+memory | Integer
+name | String
+networkrate | Integer
+offerha | [TrueClass, FalseClass]
+serviceofferingdetails | Hash
+storagetype | String
+systemvmtype | String
+tags | String
+
+## SshKeyPair
+### Attributes
+
+Attribute | Type
+---|---
+fingerprint | String
+name | String
+
+## Tag
+### Attributes
+
+Attribute | Type
+---|---
+key | String
+value | String
+resourcetype | String
+
+## Template
+### Attributes
+
+Attribute | Type
+---|---
+bootable | [TrueClass, FalseClass]
+checksum | String
+created | String
+crossZones | [TrueClass, FalseClass]
+details | Hash
+displaytext | String
+format | String
+hypervisor | String
+isdynamicallyscalable | [TrueClass, FalseClass]
+isextractable | [TrueClass, FalseClass]
+isfeatured | [TrueClass, FalseClass]
+ispublic | [TrueClass, FalseClass]
+isready | [TrueClass, FalseClass]
+name | String
+passwordenabled | [TrueClass, FalseClass]
+removed | [TrueClass, FalseClass]
+size | Integer
+sshkeyenabled | [TrueClass, FalseClass]
+status | String
+templatetag | String
+templatetype | String
+
+## VirtualMachine
+### Attributes
+
+Attribute | Type
+---|---
+cpunumber | Integer
+cpuspeed | Integer
+cpuused | String
+created | String
+displayname | String
+displayvm | [TrueClass, FalseClass]
+haenable | [TrueClass, FalseClass]
+hypervisor | String
+instancename | String
+isdynamicallyscalable | [TrueClass, FalseClass]
+memory | Integer
+name | String
+networkkbsread | Integer
+networkkbswrite | Integer
+passwordenabled | [TrueClass, FalseClass]
+rootdeviceid | Integer
+rootdevicetype | String
+state | String
+
+## Zone
+### Attributes
+
+Attribute | Type
+---|---
+allocationstate | String
+capacity | Hash
+description | String
+dhcpprovider | String
+displaytext | String
+dns1 | String
+dns2 | String
+guestcidraddress | String
+internaldns1 | String
+internaldns2 | String
+ip6dns1 | String
+ip6dns2 | String
+localstorageenabled | [TrueClass, FalseClass]
+name | String
+networktype | String
+resourcedetails | Hash
+securitygroupsenabled | [TrueClass, FalseClass]
+vlan | String
+zonetoken | String
+

data/lib/ocs.rb

@@ -10,9 +10,9 @@ require "faraday"
 require "faraday_middleware"
 
 module Ocs
-  class OcsError < StandardError; end
 end
 
+require "ocs/errors"
 require "ocs/api_error"
 require "ocs/client"
 require "ocs/request"

data/lib/ocs/client.rb

@@ -54,7 +54,7 @@ module Ocs
       
       raw_resource_name, *arguments = args
       resource_name = raw_resource_name.to_s.singularize
-      if Resources.const_defined?(resource_name.camelize)
+      if Ocs::Resources.const_defined?(resource_name.camelize)
         return resource_class(resource_name).public_send(method, self, *arguments)
       end
 

data/lib/ocs/document/generator.rb

@@ -0,0 +1,111 @@
+require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/string/inflections"
+require "erubis"
+
+module Ocs
+  module Document
+    class Generator
+      class_attribute :resources
+      self.resources = {}
+
+      class << self
+        def documents_path
+          File.expand_path("../../../../docs", __FILE__)
+        end
+
+        def library_path
+          File.expand_path("../../../", __FILE__)
+        end
+
+        def ocs_path
+          File.join(library_path, "ocs")
+        end
+        
+        def patches_path
+          File.join(ocs_path, "document/patches")
+        end
+
+        def resources_path
+          File.join(ocs_path, "resources")
+        end
+
+        def resource_paths
+          Dir[File.join(resources_path, "*.rb")]
+        end
+      end
+
+      def initialize
+
+      end
+
+      def generate
+        require "ocs/errors"
+        Patches.patch("ocs/resources/base")
+        self.class.resource_paths.each do |resource|
+          name = resource.sub(/^.+\//, "").sub(/\.rb$/, "").camelize
+          self.class.resources[name] = {}
+          require resource
+        end
+        output
+      end
+
+      private
+
+      def output
+        output_resources
+      end
+
+      def output_resources
+        File.write(File.join(self.class.documents_path, "resources.md"), resources_markdown)
+      end
+
+      def render_resource_markdown(name, attributes)
+        p name
+        p attributes
+        ::Erubis::Eruby.new(resource_template).evaluate(name: name, attributes: attributes)
+      end
+
+      def resource_template
+        File.read(File.expand_path("../templates/_resource.md.erb", __FILE__))
+      end
+
+      def resources_contents
+        self.class.resources.map { |name, attributes| render_resource_markdown(name, attributes) }
+      end
+
+      def resources_markdown
+        ::Erubis::Eruby.new(resources_template).evaluate { resources_contents.join("\n") }
+      end
+
+      def resources_template
+        File.read(File.expand_path("../templates/resources.md.erb", __FILE__))
+      end
+    end
+
+    module Patches
+      class << self
+        def patch(target_class_path)
+          patch_class_path  = "ocs/document/patches/#{target_class_path}"
+          require target_class_path
+          require patch_class_path
+          target_class = target_class_path.camelize.constantize
+          patch_class  = patch_class_path.camelize.constantize
+          target_class.prepend(patch_class)
+          if patch_class.const_defined?(:ClassMethods)
+            target_class.singleton_class.instance_eval { self.prepend(patch_class::ClassMethods) }
+          end
+        end
+      end
+
+      module Ocs
+        module Resources
+          module Base
+            module ClassMethods
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ocs/document/patches/ocs/resources/base.rb

@@ -0,0 +1,18 @@
+module Ocs
+  module Document
+    module Patches
+      module Ocs
+        module Resources
+          module Base
+            module ClassMethods
+              def define_attribute(attribute_name, type:)
+                ::Ocs::Document::Generator.resources[to_s.split(/::/).last][attribute_name] = {type: type}
+                super
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ocs/document/templates/_resource.md.erb

@@ -0,0 +1,8 @@
+## <%= @name %>
+### Attributes
+
+Attribute | Type
+---|---
+<%- @attributes.each do |name, contents| %>
+<%= name %> | <%= contents[:type] %>
+<%- end %>

data/lib/ocs/document/templates/resources.md.erb

@@ -0,0 +1,4 @@
+Resouces
+========
+
+<%= yield %>

data/lib/ocs/errors.rb

@@ -0,0 +1,6 @@
+module Ocs
+  class OcsError < StandardError; end
+  class AttributeClassMismatch < OcsError; end
+  class AttributeTypeMismatch < OcsError; end
+  class MissingKey < OcsError; end
+end

data/lib/ocs/resources.rb

@@ -1,10 +1,12 @@
+require "ocs/resources/dynamic_definers"
+require "ocs/resources/base"
+
 module Ocs
   module Resources
     autoload :Account,         "ocs/resources/account"
     autoload :Address,         "ocs/resources/address"
     autoload :AffinityGroup,   "ocs/resources/affinity_group"
     autoload :AsyncJob,        "ocs/resources/async_job"
-    autoload :Base,            "ocs/resources/base"
     autoload :DiskOffering,    "ocs/resources/disk_offering"
     autoload :Domain,          "ocs/resources/domain"
     autoload :Group,           "ocs/resources/group"

data/lib/ocs/resources/base.rb

@@ -1,9 +1,5 @@
 module Ocs
   module Resources
-    class AttributeTypeError < OcsError; end
-    class AttributeClassError < OcsError; end
-    class MissingKeyError < OcsError; end
-
     class Base
       BOOLEAN = [TrueClass, FalseClass].freeze
 
@@ -11,6 +7,8 @@ module Ocs
       self.delegations = {}
 
       class << self
+        include DynamicDefiners
+
         def all(client)
           list(client)
         end
@@ -65,99 +63,12 @@ module Ocs
             end
           end
         end
-
-        # Dynamic Definitions
-
-        def alias_attribute(new_name, original_name)
-          alias_method new_name, original_name
-          alias_method :"#{new_name}=", :"#{original_name}="
-        end
-
-        def define_action(action_name, required: [], optional: [], api_name: nil)
-          define_method(action_name) do |special_parameters = {}|
-            api = api_name || "#{action_name}#{self.class.name}"
-            parameters = action_parameters(required, optional).merge(special_parameters)
-            send_and_update(api, parameters)
-          end
-        end
-
-        def define_attribute(attribute_name, type:)
-          define_method(:"#{attribute_name}=") do |value|
-            unless [*type].any? { |type| value.is_a?(type) }
-              raise AttributeTypeError.new(
-                "#{attribute_name} needs to be a #{[*type].join(" or ")}"
-              )
-            end
-            instance_variable_set(:"@#{attribute_name}", value)
-          end
-
-          attr_reader attribute_name
-        end
-
-        def delegate_attribute(attribute_name, to:, as:)
-          writer_method_name = :"#{to}_#{as}="
-          define_method(writer_method_name) do |value|
-            instance =
-              public_send(to) ||
-              public_send(:"#{to}=", resource_class(to).new(client))
-            instance.public_send(:"#{as}=", value)
-          end
-          delegations[attribute_name] = writer_method_name
-
-          define_method(:"#{to}_#{as}") do
-            instance = public_send(to)
-            instance && instance.public_send(as)
-          end
-        end
-
-        def delegate_attributes(attribute_name, to:)
-          delegations[attribute_name] = :"#{to}="
-        end
-
-        def has_one(attribute_name)
-          define_method(:"#{attribute_name}=") do |value|
-            klass = resource_class(attribute_name)
-            unless value.instance_of?(klass)
-              raise AttributeClassError.new(
-                "#{attribute_name} needs to be an instance of #{klass}"
-              )
-            end
-            instance_variable_set(:"@#{attribute_name}", value)
-          end
-
-          attr_reader attribute_name
-        end
-
-        def has_many(attribute_name)
-          define_method(:"#{attribute_name}=") do |values|
-            unless values.is_a?(Array)
-              raise AttributeTypeError.new("#{attribute_name} needs to be a Array")
-            end
-
-            klass = resource_class(attribute_name.to_s.singularize)
-            instances = values.map do |value|
-              case value
-              when klass
-                value
-              when Hash
-                klass.new(client, value)
-              else
-                raise AttributeClassError.new(
-                  "elements of #{attribute_name} need to be instances of #{klass}"
-                )
-              end
-            end
-            instance_variable_set(:"@#{attribute_name}", instances)
-          end
-
-          attr_reader attribute_name
-        end
       end
 
-      define_attribute :id, type: String
-
       attr_reader :client, :error
 
+      define_attribute :id, type: String
+
       def initialize(client, raw_hash = {})
         @client   = client
         @raw_hash = raw_hash
@@ -205,7 +116,7 @@ module Ocs
         if response.success?
           @error = nil
           update_attributes!(response.content)
-          true
+          self
         else
           @error = ApiError.new(api, parameters, response)
           false

data/lib/ocs/resources/dynamic_definers.rb

@@ -0,0 +1,94 @@
+module Ocs
+  module Resources
+    module DynamicDefiners
+      def alias_attribute(alias_name, original_name)
+        alias_method alias_name, original_name
+        alias_method :"#{alias_name}=", :"#{original_name}="
+      end
+
+      def define_action(action_name, required: [], optional: [], api_name: nil)
+        define_method(action_name) do |special_parameters = {}|
+          api = api_name || "#{action_name}#{self.class.name}"
+          parameters = action_parameters(required, optional).merge(special_parameters)
+          send_and_update(api, parameters)
+        end
+
+        define_method(:"#{action_name}!") do |special_parameters = {}|
+          send(action_name) || fail(@error)
+        end
+      end
+
+      def define_attribute(attribute_name, type:)
+        define_method(:"#{attribute_name}=") do |value|
+          unless [*type].any? { |t| value.is_a?(t) }
+            fail AttributeTypeMismatch.new(
+              "#{attribute_name} needs to be a #{[*type].join(" or ")}"
+            )
+          end
+          instance_variable_set(:"@#{attribute_name}", value)
+        end
+
+        attr_reader attribute_name
+      end
+
+      def delegate_attribute(attribute_name, to:, as:)
+        writer_method_name = :"#{to}_#{as}="
+        define_method(writer_method_name) do |value|
+          instance =
+            public_send(to) ||
+            public_send(:"#{to}=", resource_class(to).new(client))
+          instance.public_send(:"#{as}=", value)
+        end
+        delegations[attribute_name] = writer_method_name
+
+        define_method(:"#{to}_#{as}") do
+          instance = public_send(to)
+          instance && instance.public_send(as)
+        end
+      end
+
+      def delegate_attributes(attribute_name, to:)
+        delegations[attribute_name] = :"#{to}="
+      end
+
+      def has_one(attribute_name)
+        define_method(:"#{attribute_name}=") do |value|
+          klass = resource_class(attribute_name)
+          unless value.instance_of?(klass)
+            fail AttributeClassMismatch.new(
+              "#{attribute_name} needs to be an instance of #{klass}"
+            )
+          end
+          instance_variable_set(:"@#{attribute_name}", value)
+        end
+
+        attr_reader attribute_name
+      end
+
+      def has_many(attribute_name)
+        define_method(:"#{attribute_name}=") do |values|
+          unless values.is_a?(Array)
+            fail AttributeTypeMismatch.new("#{attribute_name} needs to be an Array")
+          end
+
+          klass = resource_class(attribute_name.to_s.singularize)
+          instances = values.map do |value|
+            case value
+            when klass
+              value
+            when Hash
+              klass.new(client, value)
+            else
+              fail AttributeClassMismatch.new(
+                "Elements of #{attribute_name} need to be instances of #{klass} or Hash"
+              )
+            end
+          end
+          instance_variable_set(:"@#{attribute_name}", instances)
+        end
+
+        attr_reader attribute_name
+      end
+    end
+  end
+end

data/lib/ocs/version.rb

@@ -1,3 +1,3 @@
 module Ocs
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/ocs.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "memoist"
 
+  spec.add_development_dependency "erubis"
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ocs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - nownabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,9 +138,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/resources.md
 - lib/ocs.rb
 - lib/ocs/api_error.rb
 - lib/ocs/client.rb
+- lib/ocs/document/generator.rb
+- lib/ocs/document/patches/ocs/resources/base.rb
+- lib/ocs/document/templates/_resource.md.erb
+- lib/ocs/document/templates/resources.md.erb
+- lib/ocs/errors.rb
 - lib/ocs/request.rb
 - lib/ocs/resources.rb
 - lib/ocs/resources/account.rb
@@ -136,6 +156,7 @@ files:
 - lib/ocs/resources/base.rb
 - lib/ocs/resources/disk_offering.rb
 - lib/ocs/resources/domain.rb
+- lib/ocs/resources/dynamic_definers.rb
 - lib/ocs/resources/group.rb
 - lib/ocs/resources/host.rb
 - lib/ocs/resources/iso.rb
@@ -178,3 +199,4 @@ signing_key:
 specification_version: 4
 summary: Ocs is an objective CloudStack API client.
 test_files: []
+has_rdoc: