shortcut_client_ruby 0.0.2

data/lib/shortcut_client_ruby/models/workflow_state.rb

@@ -0,0 +1,374 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+require 'date'
+
+module Shortcut
+  # Workflow State is any of the at least 3 columns. Workflow States correspond to one of 3 types: Unstarted, Started, or Done.
+  class WorkflowState
+    # The description of what sort of Stories belong in that Workflow state.
+    attr_accessor :description
+
+    # A string description of this resource.
+    attr_accessor :entity_type
+
+    # The hex color for this Workflow State.
+    attr_accessor :color
+
+    # The verb that triggers a move to that Workflow State when making VCS commits.
+    attr_accessor :verb
+
+    # The Workflow State's name.
+    attr_accessor :name
+
+    # The number of Stories currently in that Workflow State.
+    attr_accessor :num_stories
+
+    # The type of Workflow State (Unstarted, Started, or Finished)
+    attr_accessor :type
+
+    # When the Workflow State was last updated.
+    attr_accessor :updated_at
+
+    # The unique ID of the Workflow State.
+    attr_accessor :id
+
+    # The number of Story Templates associated with that Workflow State.
+    attr_accessor :num_story_templates
+
+    # The position that the Workflow State is in, starting with 0 at the left.
+    attr_accessor :position
+
+    # The time/date the Workflow State was created.
+    attr_accessor :created_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'entity_type' => :'entity_type',
+        :'color' => :'color',
+        :'verb' => :'verb',
+        :'name' => :'name',
+        :'num_stories' => :'num_stories',
+        :'type' => :'type',
+        :'updated_at' => :'updated_at',
+        :'id' => :'id',
+        :'num_story_templates' => :'num_story_templates',
+        :'position' => :'position',
+        :'created_at' => :'created_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'description' => :'Object',
+        :'entity_type' => :'Object',
+        :'color' => :'Object',
+        :'verb' => :'Object',
+        :'name' => :'Object',
+        :'num_stories' => :'Object',
+        :'type' => :'Object',
+        :'updated_at' => :'Object',
+        :'id' => :'Object',
+        :'num_story_templates' => :'Object',
+        :'position' => :'Object',
+        :'created_at' => :'Object'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'verb',
+      ])
+    end
+  
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shortcut::WorkflowState` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shortcut::WorkflowState`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'color')
+        self.color = attributes[:'color']
+      end
+
+      if attributes.key?(:'verb')
+        self.verb = attributes[:'verb']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'num_stories')
+        self.num_stories = attributes[:'num_stories']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'num_story_templates')
+        self.num_story_templates = attributes[:'num_story_templates']
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @entity_type.nil?
+        invalid_properties.push('invalid value for "entity_type", entity_type cannot be nil.')
+      end
+
+      if @verb.nil?
+        invalid_properties.push('invalid value for "verb", verb cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @num_stories.nil?
+        invalid_properties.push('invalid value for "num_stories", num_stories cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @num_story_templates.nil?
+        invalid_properties.push('invalid value for "num_story_templates", num_story_templates cannot be nil.')
+      end
+
+      if @position.nil?
+        invalid_properties.push('invalid value for "position", position cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      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?
+      return false if @description.nil?
+      return false if @entity_type.nil?
+      return false if @verb.nil?
+      return false if @name.nil?
+      return false if @num_stories.nil?
+      return false if @type.nil?
+      return false if @updated_at.nil?
+      return false if @id.nil?
+      return false if @num_story_templates.nil?
+      return false if @position.nil?
+      return false if @created_at.nil?
+      true
+    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 &&
+          description == o.description &&
+          entity_type == o.entity_type &&
+          color == o.color &&
+          verb == o.verb &&
+          name == o.name &&
+          num_stories == o.num_stories &&
+          type == o.type &&
+          updated_at == o.updated_at &&
+          id == o.id &&
+          num_story_templates == o.num_story_templates &&
+          position == o.position &&
+          created_at == o.created_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [description, entity_type, color, verb, name, num_stories, type, updated_at, id, num_story_templates, position, created_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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]]))
+        elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        end
+      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 =~ /\A(true|t|yes|y|1)\z/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
+        Shortcut.const_get(type).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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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/shortcut_client_ruby/version.rb

@@ -0,0 +1,14 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+module Shortcut
+  VERSION = '0.0.2'
+end

data/lib/shortcut_client_ruby.rb

@@ -0,0 +1,181 @@
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+# Common files
+require 'shortcut_client_ruby/api_client'
+require 'shortcut_client_ruby/api_error'
+require 'shortcut_client_ruby/version'
+require 'shortcut_client_ruby/configuration'
+
+# Models
+require 'shortcut_client_ruby/models/basic_workspace_info'
+require 'shortcut_client_ruby/models/branch'
+require 'shortcut_client_ruby/models/category'
+require 'shortcut_client_ruby/models/commit'
+require 'shortcut_client_ruby/models/create_category'
+require 'shortcut_client_ruby/models/create_category_params'
+require 'shortcut_client_ruby/models/create_comment_comment'
+require 'shortcut_client_ruby/models/create_entity_template'
+require 'shortcut_client_ruby/models/create_epic'
+require 'shortcut_client_ruby/models/create_epic_comment'
+require 'shortcut_client_ruby/models/create_group'
+require 'shortcut_client_ruby/models/create_iteration'
+require 'shortcut_client_ruby/models/create_label_params'
+require 'shortcut_client_ruby/models/create_linked_file'
+require 'shortcut_client_ruby/models/create_milestone'
+require 'shortcut_client_ruby/models/create_or_delete_story_reaction'
+require 'shortcut_client_ruby/models/create_project'
+require 'shortcut_client_ruby/models/create_stories'
+require 'shortcut_client_ruby/models/create_story_comment'
+require 'shortcut_client_ruby/models/create_story_comment_params'
+require 'shortcut_client_ruby/models/create_story_contents'
+require 'shortcut_client_ruby/models/create_story_link'
+require 'shortcut_client_ruby/models/create_story_link_params'
+require 'shortcut_client_ruby/models/create_story_params'
+require 'shortcut_client_ruby/models/create_task'
+require 'shortcut_client_ruby/models/create_task_params'
+require 'shortcut_client_ruby/models/delete_stories'
+require 'shortcut_client_ruby/models/entity_template'
+require 'shortcut_client_ruby/models/entity_template_task'
+require 'shortcut_client_ruby/models/epic'
+require 'shortcut_client_ruby/models/epic_search_results'
+require 'shortcut_client_ruby/models/epic_slim'
+require 'shortcut_client_ruby/models/epic_state'
+require 'shortcut_client_ruby/models/epic_stats'
+require 'shortcut_client_ruby/models/epic_workflow'
+require 'shortcut_client_ruby/models/get_epic_stories'
+require 'shortcut_client_ruby/models/get_external_link_stories_params'
+require 'shortcut_client_ruby/models/get_iteration_stories'
+require 'shortcut_client_ruby/models/get_label_stories'
+require 'shortcut_client_ruby/models/get_member'
+require 'shortcut_client_ruby/models/get_project_stories'
+require 'shortcut_client_ruby/models/group'
+require 'shortcut_client_ruby/models/history'
+require 'shortcut_client_ruby/models/history_action_branch_create'
+require 'shortcut_client_ruby/models/history_action_branch_merge'
+require 'shortcut_client_ruby/models/history_action_branch_push'
+require 'shortcut_client_ruby/models/history_action_label_create'
+require 'shortcut_client_ruby/models/history_action_label_delete'
+require 'shortcut_client_ruby/models/history_action_label_update'
+require 'shortcut_client_ruby/models/history_action_project_update'
+require 'shortcut_client_ruby/models/history_action_pull_request'
+require 'shortcut_client_ruby/models/history_action_story_comment_create'
+require 'shortcut_client_ruby/models/history_action_story_create'
+require 'shortcut_client_ruby/models/history_action_story_delete'
+require 'shortcut_client_ruby/models/history_action_story_link_create'
+require 'shortcut_client_ruby/models/history_action_story_link_delete'
+require 'shortcut_client_ruby/models/history_action_story_link_update'
+require 'shortcut_client_ruby/models/history_action_story_update'
+require 'shortcut_client_ruby/models/history_action_task_create'
+require 'shortcut_client_ruby/models/history_action_task_delete'
+require 'shortcut_client_ruby/models/history_action_task_update'
+require 'shortcut_client_ruby/models/history_changes_story'
+require 'shortcut_client_ruby/models/history_changes_story_link'
+require 'shortcut_client_ruby/models/history_changes_task'
+require 'shortcut_client_ruby/models/history_reference_branch'
+require 'shortcut_client_ruby/models/history_reference_commit'
+require 'shortcut_client_ruby/models/history_reference_epic'
+require 'shortcut_client_ruby/models/history_reference_general'
+require 'shortcut_client_ruby/models/history_reference_group'
+require 'shortcut_client_ruby/models/history_reference_iteration'
+require 'shortcut_client_ruby/models/history_reference_label'
+require 'shortcut_client_ruby/models/history_reference_project'
+require 'shortcut_client_ruby/models/history_reference_story'
+require 'shortcut_client_ruby/models/history_reference_story_task'
+require 'shortcut_client_ruby/models/history_reference_workflow_state'
+require 'shortcut_client_ruby/models/icon'
+require 'shortcut_client_ruby/models/identity'
+require 'shortcut_client_ruby/models/iteration'
+require 'shortcut_client_ruby/models/iteration_slim'
+require 'shortcut_client_ruby/models/iteration_stats'
+require 'shortcut_client_ruby/models/label'
+require 'shortcut_client_ruby/models/label_slim'
+require 'shortcut_client_ruby/models/label_stats'
+require 'shortcut_client_ruby/models/linked_file'
+require 'shortcut_client_ruby/models/list_epics'
+require 'shortcut_client_ruby/models/list_group_stories'
+require 'shortcut_client_ruby/models/list_labels'
+require 'shortcut_client_ruby/models/list_members'
+require 'shortcut_client_ruby/models/max_search_results_exceeded_error'
+require 'shortcut_client_ruby/models/member'
+require 'shortcut_client_ruby/models/member_info'
+require 'shortcut_client_ruby/models/milestone'
+require 'shortcut_client_ruby/models/milestone_stats'
+require 'shortcut_client_ruby/models/profile'
+require 'shortcut_client_ruby/models/project'
+require 'shortcut_client_ruby/models/project_stats'
+require 'shortcut_client_ruby/models/pull_request'
+require 'shortcut_client_ruby/models/pull_request_label'
+require 'shortcut_client_ruby/models/repository'
+require 'shortcut_client_ruby/models/search'
+require 'shortcut_client_ruby/models/search_results'
+require 'shortcut_client_ruby/models/search_stories'
+require 'shortcut_client_ruby/models/story'
+require 'shortcut_client_ruby/models/story_comment'
+require 'shortcut_client_ruby/models/story_contents'
+require 'shortcut_client_ruby/models/story_contents_task'
+require 'shortcut_client_ruby/models/story_history_change_adds_removes_int'
+require 'shortcut_client_ruby/models/story_history_change_adds_removes_uuid'
+require 'shortcut_client_ruby/models/story_history_change_old_new_bool'
+require 'shortcut_client_ruby/models/story_history_change_old_new_int'
+require 'shortcut_client_ruby/models/story_history_change_old_new_str'
+require 'shortcut_client_ruby/models/story_history_change_old_new_uuid'
+require 'shortcut_client_ruby/models/story_link'
+require 'shortcut_client_ruby/models/story_reaction'
+require 'shortcut_client_ruby/models/story_search_results'
+require 'shortcut_client_ruby/models/story_slim'
+require 'shortcut_client_ruby/models/story_stats'
+require 'shortcut_client_ruby/models/task'
+require 'shortcut_client_ruby/models/threaded_comment'
+require 'shortcut_client_ruby/models/typed_story_link'
+require 'shortcut_client_ruby/models/unusable_entitlement_error'
+require 'shortcut_client_ruby/models/update_category'
+require 'shortcut_client_ruby/models/update_comment'
+require 'shortcut_client_ruby/models/update_entity_template'
+require 'shortcut_client_ruby/models/update_epic'
+require 'shortcut_client_ruby/models/update_file'
+require 'shortcut_client_ruby/models/update_group'
+require 'shortcut_client_ruby/models/update_iteration'
+require 'shortcut_client_ruby/models/update_label'
+require 'shortcut_client_ruby/models/update_linked_file'
+require 'shortcut_client_ruby/models/update_milestone'
+require 'shortcut_client_ruby/models/update_project'
+require 'shortcut_client_ruby/models/update_stories'
+require 'shortcut_client_ruby/models/update_story'
+require 'shortcut_client_ruby/models/update_story_comment'
+require 'shortcut_client_ruby/models/update_story_contents'
+require 'shortcut_client_ruby/models/update_story_link'
+require 'shortcut_client_ruby/models/update_task'
+require 'shortcut_client_ruby/models/uploaded_file'
+require 'shortcut_client_ruby/models/v3_files_body'
+require 'shortcut_client_ruby/models/workflow'
+require 'shortcut_client_ruby/models/workflow_state'
+
+# APIs
+require 'shortcut_client_ruby/api/default_api'
+
+module Shortcut
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Shortcut.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/shortcut-client-ruby.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/shortcut/client/ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shortcut-client-ruby"
+  spec.version       = Shortcut::Client::Ruby::VERSION
+  spec.authors       = ["ngouy"]
+  spec.email         = ["nate@alleycorpnord.com"]
+
+  spec.summary       = "TODO: Write a short summary, because RubyGems requires one."
+  spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/shortcut_client_ruby.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Shortcut API
+
+#Shortcut API
+
+OpenAPI spec version: 3.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 3.0.35
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "shortcut_client_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shortcut_client_ruby"
+  s.version     = Shortcut::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Swagger-Codegen"]
+  s.email       = [""]
+  s.homepage    = "https://github.com/swagger-api/swagger-codegen"
+  s.summary     = "Shortcut API Ruby Gem"
+  s.description = "Shortcut API"
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end