blueprint_ruby_client 0.1.0

data/templates/model.mustache

@@ -0,0 +1,242 @@
+=begin
+{{> api_info}}
+=end
+
+require 'date'
+
+module {{moduleName}}{{#models}}{{#model}}{{#description}}
+  # {{{description}}}{{/description}}
+  class {{classname}}{{#vars}}{{#description}}
+    # {{{description}}}{{/description}}
+    attr_accessor :{{{name}}}
+{{/vars}}
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{baseName}}}'{{#hasMore}},{{/hasMore}}
+        {{/vars}}
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        {{#vars}}
+        :'{{{name}}}' => :'{{{datatype}}}'{{#hasMore}},{{/hasMore}}
+        {{/vars}}
+      }
+    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}
+
+      {{#vars}}
+      if attributes.has_key?(:'{{{baseName}}}')
+        {{#isContainer}}
+        if (value = attributes[:'{{{baseName}}}']).is_a?(Array)
+          self.{{{name}}} = value
+        end
+        {{/isContainer}}
+        {{^isContainer}}
+        self.{{{name}}} = attributes[:'{{{baseName}}}']
+        {{/isContainer}}
+      {{#defaultValue}}
+      else
+        self.{{{name}}} = {{{defaultValue}}}
+      {{/defaultValue}}
+      end
+
+      {{/vars}}
+    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
+      {{#isEnum}}
+      allowed_values = [{{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}]
+      if @{{{name}}} && !allowed_values.include?({{{name}}})
+        invalid_properties.push("invalid value for '{{{name}}}', must be one of #{allowed_values}.")
+      end
+
+      {{/isEnum}}
+      {{#hasValidation}}
+      if @{{{name}}}.nil?
+        fail ArgumentError, "{{{name}}} cannot be nil"
+      end
+
+      {{#minLength}}
+      if @{{{name}}}.to_s.length > {{{maxLength}}}
+        invalid_properties.push("invalid value for '{{{name}}}', the character length must be smaller than or equal to {{{maxLength}}}.")
+      end
+
+      {{/minLength}}
+      {{#maxLength}}
+      if @{{{name}}}.to_s.length < {{{minLength}}}
+        invalid_properties.push("invalid value for '{{{name}}}', the character length must be great than or equal to {{{minLength}}}.")
+      end
+
+      {{/maxLength}}
+      {{#maximum}}
+      if @{{{name}}} > {{{maximum}}}
+        invalid_properties.push("invalid value for '{{{name}}}', must be smaller than or equal to {{{maximum}}}.")
+      end
+
+      {{/maximum}}
+      {{#minimum}}
+      if @{{{name}}} < {{{minimum}}}
+        invalid_properties.push("invalid value for '{{{name}}}', must be greater than or equal to {{{minimum}}}.")
+      end
+
+      {{/minimum}}
+      {{#pattern}}
+      if @{{{name}}} !~ Regexp.new({{{pattern}}})
+        invalid_properties.push("invalid value for '{{{name}}}', must conform to the pattern {{{pattern}}}.")
+      end
+
+      {{/pattern}}
+      {{/hasValidation}}
+      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?
+      {{#vars}}
+      {{#required}}
+      if @{{{name}}}.nil?
+        return false
+      end
+
+      {{/required}}
+      {{#isEnum}}
+      allowed_values = [{{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}]
+      if @{{{name}}} && !allowed_values.include?(@{{{name}}})
+        return false
+      end
+      {{/isEnum}}
+      {{#hasValidation}}
+      {{#minLength}}
+      if @{{{name}}}.to_s.length > {{{maxLength}}}
+        return false
+      end
+
+      {{/minLength}}
+      {{#maxLength}}
+      if @{{{name}}}.to_s.length < {{{minLength}}}
+        return false
+      end
+
+      {{/maxLength}}
+      {{#maximum}}
+      if @{{{name}}} > {{{maximum}}}
+        return false
+      end
+
+      {{/maximum}}
+      {{#minimum}}
+      if @{{{name}}} < {{{minimum}}}
+        return false
+      end
+
+      {{/minimum}}
+      {{#pattern}}
+      if @{{{name}}} !~ Regexp.new({{{pattern}}})
+        return false
+      end
+
+      {{/pattern}}
+      {{/hasValidation}}
+      {{/vars}}
+    end
+
+    {{#vars}}
+    {{#isEnum}}
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] {{{name}}} Object to be assigned
+    def {{{name}}}=({{{name}}})
+      allowed_values = [{{#allowableValues}}{{#values}}"{{{this}}}"{{^-last}}, {{/-last}}{{/values}}{{/allowableValues}}]
+      if {{{name}}} && !allowed_values.include?({{{name}}})
+        fail ArgumentError, "invalid value for '{{{name}}}', must be one of #{allowed_values}."
+      end
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/isEnum}}
+    {{^isEnum}}
+    {{#hasValidation}}
+    # Custom attribute writer method with validation
+    # @param [Object] {{{name}}} Value to be assigned
+    def {{{name}}}=({{{name}}})
+      if {{{name}}}.nil?
+        fail ArgumentError, "{{{name}}} cannot be nil"
+      end
+
+      {{#minLength}}
+      if {{{name}}}.to_s.length > {{{maxLength}}}
+        fail ArgumentError, "invalid value for '{{{name}}}', the character length must be smaller than or equal to {{{maxLength}}}."
+      end
+
+      {{/minLength}}
+      {{#maxLength}}
+      if {{{name}}}.to_s.length < {{{minLength}}}
+        fail ArgumentError, "invalid value for '{{{name}}}', the character length must be great than or equal to {{{minLength}}}."
+      end
+
+      {{/maxLength}}
+      {{#maximum}}
+      if {{{name}}} > {{{maximum}}}
+        fail ArgumentError, "invalid value for '{{{name}}}', must be smaller than or equal to {{{maximum}}}."
+      end
+
+      {{/maximum}}
+      {{#minimum}}
+      if {{{name}}} < {{{minimum}}}
+        fail ArgumentError, "invalid value for '{{{name}}}', must be greater than or equal to {{{minimum}}}."
+      end
+
+      {{/minimum}}
+      {{#pattern}}
+      if @{{{name}}} !~ Regexp.new({{{pattern}}})
+        fail ArgumentError, "invalid value for '{{{name}}}', must conform to the pattern {{{pattern}}}."
+      end
+
+      {{/pattern}}
+      @{{{name}}} = {{{name}}}
+    end
+
+    {{/hasValidation}}
+    {{/isEnum}}
+    {{/vars}}
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared 
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class{{#vars}} &&
+          {{name}} == o.{{name}}{{/vars}}
+    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
+      [{{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}].hash
+    end
+
+{{> base_object}}
+  end
+{{/model}}
+{{/models}}
+end

data/templates/model_doc.mustache

@@ -0,0 +1,9 @@
+{{#models}}{{#model}}# {{moduleName}}::{{classname}}
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{datatype}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{datatype}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{defaultValue}}]{{/defaultValue}}
+{{/vars}}
+
+{{/model}}{{/models}}

data/templates/model_test.mustache

@@ -0,0 +1,40 @@
+=begin
+{{> api_info}}
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for {{moduleName}}::{{classname}}
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+{{#models}}{{#model}}describe '{{classname}}' do
+  before do
+    # run before each test
+    @instance = {{moduleName}}::{{classname}}.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of {{classname}}' do
+    it 'should create an instact of {{classname}}' do
+      @instance.should be_a({{moduleName}}::{{classname}}) 
+    end
+  end
+{{#vars}}
+  describe 'test attribute "{{{name}}}"' do
+    it 'should work' do
+       # assertion here
+       # should be_a()
+       # should be_nil
+       # should ==
+       # should_not ==
+    end
+  end
+
+{{/vars}}
+end
+{{/model}}{{/models}}

data/templates/version.mustache

@@ -0,0 +1,7 @@
+=begin
+{{> api_info}}
+=end
+
+module {{moduleName}}
+  VERSION = "{{gemVersion}}"
+end

metadata

@@ -0,0 +1,322 @@
+--- !ruby/object:Gem::Specification
+name: blueprint_ruby_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Paddock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.24.3
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.6
+- !ruby/object:Gem::Dependency
+  name: autotest-rails-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.2
+- !ruby/object:Gem::Dependency
+  name: autotest-growl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.16
+- !ruby/object:Gem::Dependency
+  name: autotest-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.11
+description: A client to utilise the hierarchy modelling abilities of Blueprint
+email:
+- bp@talis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- blueprint_ruby_client.gemspec
+- config.json
+- docs/Asset.md
+- docs/AssetBody.md
+- docs/AssetResultSet.md
+- docs/AssetsApi.md
+- docs/Error.md
+- docs/Errors.md
+- docs/HierarchyApi.md
+- docs/Links.md
+- docs/Meta.md
+- docs/Namespace.md
+- docs/NamespaceRelationship.md
+- docs/Node.md
+- docs/NodeAttributes.md
+- docs/NodeBody.md
+- docs/NodeRelationship.md
+- docs/NodeRelationships.md
+- docs/NodeResultSet.md
+- generate.sh
+- git_push.sh
+- lib/blueprint_ruby_client.rb
+- lib/blueprint_ruby_client/api/assets_api.rb
+- lib/blueprint_ruby_client/api/hierarchy_api.rb
+- lib/blueprint_ruby_client/api_client.rb
+- lib/blueprint_ruby_client/api_error.rb
+- lib/blueprint_ruby_client/configuration.rb
+- lib/blueprint_ruby_client/models/asset.rb
+- lib/blueprint_ruby_client/models/asset_body.rb
+- lib/blueprint_ruby_client/models/asset_result_set.rb
+- lib/blueprint_ruby_client/models/error.rb
+- lib/blueprint_ruby_client/models/errors.rb
+- lib/blueprint_ruby_client/models/links.rb
+- lib/blueprint_ruby_client/models/meta.rb
+- lib/blueprint_ruby_client/models/namespace.rb
+- lib/blueprint_ruby_client/models/namespace_relationship.rb
+- lib/blueprint_ruby_client/models/node.rb
+- lib/blueprint_ruby_client/models/node_attributes.rb
+- lib/blueprint_ruby_client/models/node_body.rb
+- lib/blueprint_ruby_client/models/node_relationship.rb
+- lib/blueprint_ruby_client/models/node_relationships.rb
+- lib/blueprint_ruby_client/models/node_result_set.rb
+- lib/blueprint_ruby_client/version.rb
+- spec/api/assets_api_spec.rb
+- spec/api/hierarchy_api_spec.rb
+- spec/models/asset_body_spec.rb
+- spec/models/asset_result_set_spec.rb
+- spec/models/asset_spec.rb
+- spec/models/error_spec.rb
+- spec/models/errors_spec.rb
+- spec/models/links_spec.rb
+- spec/models/meta_spec.rb
+- spec/models/namespace_relationship_spec.rb
+- spec/models/namespace_spec.rb
+- spec/models/node_attributes_spec.rb
+- spec/models/node_body_spec.rb
+- spec/models/node_relationship_spec.rb
+- spec/models/node_relationships_spec.rb
+- spec/models/node_result_set_spec.rb
+- spec/models/node_spec.rb
+- swagger-codegen-cli.jar
+- templates/Gemfile.mustache
+- templates/README.mustache
+- templates/api.mustache
+- templates/api_client.mustache
+- templates/api_doc.mustache
+- templates/api_error.mustache
+- templates/api_info.mustache
+- templates/api_test.mustache
+- templates/base_object.mustache
+- templates/configuration.mustache
+- templates/gem.mustache
+- templates/gemspec.mustache
+- templates/gitignore.mustache
+- templates/model.mustache
+- templates/model_doc.mustache
+- templates/model_test.mustache
+- templates/version.mustache
+homepage: https://github.com/talis/blueprint_rb
+licenses:
+- Copyright Talis Education Ltd
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A ruby API wrapper for Blueprint
+test_files:
+- spec/api/assets_api_spec.rb
+- spec/api/hierarchy_api_spec.rb
+- spec/models/namespace_relationship_spec.rb
+- spec/models/node_result_set_spec.rb
+- spec/models/node_spec.rb
+- spec/models/asset_body_spec.rb
+- spec/models/errors_spec.rb
+- spec/models/asset_result_set_spec.rb
+- spec/models/node_relationship_spec.rb
+- spec/models/links_spec.rb
+- spec/models/node_body_spec.rb
+- spec/models/node_relationships_spec.rb
+- spec/models/meta_spec.rb
+- spec/models/error_spec.rb
+- spec/models/node_attributes_spec.rb
+- spec/models/namespace_spec.rb
+- spec/models/asset_spec.rb