blueprint_ruby_client 0.1.0

data/lib/blueprint_ruby_client/models/node_result_set.rb

@@ -0,0 +1,261 @@
+=begin
+Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'date'
+
+module BlueprintClient
+  class NodeResultSet
+    attr_accessor :meta
+
+    attr_accessor :data
+
+    attr_accessor :included
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'meta' => :'meta',
+        
+        :'data' => :'data',
+        
+        :'included' => :'included'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'meta' => :'Meta',
+        
+        :'data' => :'Array<Node>',
+        
+        :'included' => :'Array<Node>'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'meta')
+        
+        
+        self.meta = attributes[:'meta']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'data')
+        
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'included')
+        
+        if (value = attributes[:'included']).is_a?(Array)
+          self.included = value
+        end
+        
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared 
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          meta == o.meta &&
+          data == o.data &&
+          included == o.included
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared 
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [meta, data, included].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = BlueprintClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value 
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/blueprint_ruby_client/version.rb

@@ -0,0 +1,15 @@
+=begin
+Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+module BlueprintClient
+  VERSION = "0.1.0"
+end

data/lib/blueprint_ruby_client.rb

@@ -0,0 +1,56 @@
+=begin
+Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+# Common files
+require 'blueprint_ruby_client/api_client'
+require 'blueprint_ruby_client/api_error'
+require 'blueprint_ruby_client/version'
+require 'blueprint_ruby_client/configuration'
+
+# Models
+require 'blueprint_ruby_client/models/asset'
+require 'blueprint_ruby_client/models/asset_body'
+require 'blueprint_ruby_client/models/asset_result_set'
+require 'blueprint_ruby_client/models/error'
+require 'blueprint_ruby_client/models/errors'
+require 'blueprint_ruby_client/models/links'
+require 'blueprint_ruby_client/models/meta'
+require 'blueprint_ruby_client/models/namespace'
+require 'blueprint_ruby_client/models/namespace_relationship'
+require 'blueprint_ruby_client/models/node'
+require 'blueprint_ruby_client/models/node_attributes'
+require 'blueprint_ruby_client/models/node_body'
+require 'blueprint_ruby_client/models/node_relationship'
+require 'blueprint_ruby_client/models/node_relationships'
+require 'blueprint_ruby_client/models/node_result_set'
+
+# APIs
+require 'blueprint_ruby_client/api/assets_api'
+require 'blueprint_ruby_client/api/hierarchy_api'
+
+module BlueprintClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   BlueprintClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/assets_api_spec.rb

@@ -0,0 +1,150 @@
+=begin
+Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for BlueprintClient::AssetsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AssetsApi' do
+  before do
+    # run before each test
+    @instance = BlueprintClient::AssetsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AssetsApi' do
+    it 'should create an instact of AssetsApi' do
+      @instance.should be_a(BlueprintClient::AssetsApi)
+    end
+  end
+
+  # unit tests for add_asset_to_node
+  # 
+  # Add an asset to the node.  Body must be empty.  Will upsert the asset if it doesn't exist
+  # @param namespace identifier namespacing the blueprint.
+  # @param type Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param id id identifying a domain model
+  # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param asset_id id of an asset
+  # @param [Hash] opts the optional parameters
+  # @return [AssetBody]
+  describe 'add_asset_to_node test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for delete_asset
+  # 
+  # Delete an Asset
+  # @param namespace identifier namespacing the blueprint.
+  # @param asset_id id of an asset
+  # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_asset test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_asset
+  # 
+  # Get details of a given asset
+  # @param namespace identifier namespacing the blueprint.
+  # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param asset_id id of an asset
+  # @param [Hash] opts the optional parameters
+  # @return [AssetBody]
+  describe 'get_asset test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for get_assets_in_node
+  # 
+  # Get for assets in the relevant node
+  # @param namespace identifier namespacing the blueprint.
+  # @param type Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param id id identifying a domain model
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter_asset_type type of asset to return
+  # @option opts [Float] :offset index to start result set from
+  # @option opts [Float] :limit number of records to return
+  # @return [AssetResultSet]
+  describe 'get_assets_in_node test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for remove_asset_from_node
+  # 
+  # Remove an asset from the relevant node
+  # @param namespace identifier namespacing the blueprint.
+  # @param type Plural form of node type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param id id identifying a domain model
+  # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param asset_id id of an asset
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'remove_asset_from_node test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+  # unit tests for replace_asset
+  # Replaces the Asset with the data sent in the body
+  # Wholesale replacement of Asset data: if you were to PUT to:\n  /1/{namespace}/assets/sometype/someid\n\nwith a body of:\n  { type: \"someothertype\", id: \"someotherid\" }\n\nIt would change the Asset's path to:\n  /1/{namespace}/assets/someothertype/someotherid\n\nand\n  /1/{namespace}/assets/sometype/someid\nwould return a 404.\nIt would also update the assets associated with any node.\n
+  # @param namespace identifier namespacing the blueprint.
+  # @param asset_id id of an asset
+  # @param asset_type Plural form of asset type (adds an 's' to the end of the type) todo - allow configuration of plurals
+  # @param [Hash] opts the optional parameters
+  # @return [AssetBody]
+  describe 'replace_asset test' do
+    it "should work" do
+      # assertion here
+      # should be_a()
+      # should be_nil
+      # should ==
+      # should_not ==
+    end
+  end
+
+end