bio-basespace-sdk 0.1.2

data/lib/basespace/model/purchase.rb

@@ -0,0 +1,89 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/api/basespace_error'
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# Represents a BaseSpace Purchase object.
+class Purchase < Model
+
+  # Create a new Purchase instance.
+  def initialize
+    @swagger_types = {
+      'Id'                   => 'str',
+      'Status'               => 'str',       # PENDING, CANCELLED, ERRORED, COMPLETED
+      'RefundStatus'         => 'str',       # NOTREFUNDED, REFUNDED
+      'DateCreated'          => 'datetime',
+      'DateUpdated'          => 'datetime',
+      'InvoiceNumber'        => 'str',
+      'Amount'               => 'str',
+      'AmountOfTax'          => 'str',
+      'AmountTotal'          => 'str',
+      'Products'             => 'list<Product>',
+      'PurchaseType'         => 'str',
+      'AppSession'           => 'AppSessionCompact',
+      'User'                 => 'UserCompact',
+      'Application'          => 'ApplicationCompact',
+      'HrefPurchaseDialog'   => 'str',       # new purchases only
+      'RefundSecret'         => 'str',       # new purchases only
+      'ExceptionMessage'     => 'str',       # errors only
+      'ExceptionStackTrace'  => 'str',       # errors only
+      'DateRefunded'         => 'datetime',  # refunds only
+      'UserRefundedBy'       => 'str',       # refunds only
+      'RefundComment'        => 'str',       # refunds only
+    }
+    @attributes = {
+      'Id'                   => nil,
+      'Status'               => nil,
+      'RefundStatus'         => nil,
+      'DateCreated'          => nil,
+      'DateUpdated'          => nil,
+      'InvoiceNumber'        => nil,
+      'Amount'               => nil,
+      'AmountOfTax'          => nil,
+      'AmountTotal'          => nil,
+      'Products'             => nil,
+      'PurchaseType'         => nil,
+      'AppSession'           => nil,
+      'User'                 => nil,
+      'Application'          => nil,
+      'HrefPurchaseDialog'   => nil,
+      'RefundSecret'         => nil,
+      'ExceptionMessage'     => nil,
+      'ExceptionStackTrace'  => nil,
+      'DateRefunded'         => nil,
+      'UserRefundedBy'       => nil,
+      'RefundComment'        => nil,
+    }
+  end
+  
+  # Return the purchase ID.
+  def to_s
+    return @id.to_s
+  end
+
+  # Test if the Purchase instance has been initialized.
+  #
+  # Throws ModelNotInitializedError, if the object has not been populated yet.
+  def is_init
+    raise ModelNotInitializedError.new('The project model has not been initialized yet') unless get_attr('Id')
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+

data/lib/basespace/model/purchase_response.rb

@@ -0,0 +1,39 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# A Purchase response.
+class PurchaseResponse < Model
+
+  # Create a new PurchaseResponse instance.
+  def initialize
+    @swagger_types = {
+      'ResponseStatus'  => 'ResponseStatus',
+      'Response'        => 'Purchase',
+      'Notifications'   => 'list<Str>',
+    }
+    @attributes = {
+      'ResponseStatus'  => nil, # ResponseStatus
+      'Response'        => nil, # Purchase
+      'Notifications'   => nil, # list<Str>
+    }
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio

data/lib/basespace/model/purchased_product.rb

@@ -0,0 +1,56 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# Purchased product model.
+class PurchasedProduct < Model
+
+  # Create a new PurchasedProduct instance.
+  def initialize
+    @swagger_types = {
+      'PurchaseId'         => 'str',
+      'DatePurchased'      => 'datetime',
+      'Id'                 => 'str',
+      'Name'               => 'str',
+      'Price'              => 'str',
+      'Quantity'           => 'str',
+      'PersistenceStatus'  => 'str',
+      'Tags'               => 'list<str>',  # only if provided as a query parameter
+      'ProductIds'         => 'list<str>',  # only if provided as a query parameter
+    }
+    @attributes = {
+      'PurchaseId'         => nil,
+      'DatePurchased'      => nil,
+      'Id'                 => nil,
+      'Name'               => nil,
+      'Price'              => nil,
+      'Quantity'           => nil,
+      'PersistenceStatus'  => nil,
+      'Tags'               => nil,
+      'ProductIds'         => nil,
+    }
+  end
+
+  # Return the name of the purchased product.
+  def to_s
+    return get_attr('Name').to_s
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio

data/lib/basespace/model/query_parameters.rb

@@ -0,0 +1,86 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/api/basespace_error'
+
+module Bio
+module BaseSpace
+
+# The QueryParameters class can be passed as an optional arguments for
+# a specific sorting of list-responses (such as lists of Sample, AppResult,
+# or Variant).
+class QueryParameters
+  attr_accessor :passed, :required
+
+  # not very strict parameters testing
+  LEGAL = {
+    'Statuses'    => [],
+    'SortBy'      => ['Id', 'Name', 'DateCreated', 'Path', 'Position'],
+    'Format'      => ['txt'],
+    'Extensions'  => [],
+    'Offset'      => [],
+    'Limit'       => [],
+    'SortDir'     => ['Asc', 'Desc'],
+    'Name'        => [],
+  }
+
+  # Create a new QueryParameters instance.
+  #
+  # +pars+:: Query parameters.
+  # +required+:: List of required query parameters.
+  def initialize(pars = {}, required = ['SortBy', 'Offset', 'Limit', 'SortDir'])
+    @passed = {
+      'SortBy'  => 'Id',
+      'Offset'  => '0',    # [TODO] .to_i?
+      'Limit'   => '100',  # [TODO] .to_i?
+      'SortDir' => 'Asc',
+    }
+    pars.each do |k, v|
+      @passed[k] = v
+    end
+    @required = required
+  end
+
+  # Returns a string representation of all query parameters contained in the object.
+  def to_s
+    return @passed.to_s
+  end
+
+  # Returns a debugging string representation of the object.
+  def to_str
+    return self.inspect
+  end
+    
+  # Returns all query parameters.
+  def get_parameter_dict
+    return @passed
+  end
+    
+  # Check the validity of all query parameters.
+  #
+  # Throws UndefinedParameterError if a required parameters is not present.
+  def validate
+    @required.each do |p|
+      raise UndefinedParameterError.new(p) unless @passed[p]
+    end
+    @passed.each do |p, v|
+      raise UnknownParameterError.new(p) unless LEGAL[p]
+      raise IllegalParameterError.new(p, LEGAL[p]) if (LEGAL[p].length > 0 and ! LEGAL[p].include?(@passed[p]))
+    end
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+

data/lib/basespace/model/query_parameters_purchased_product.rb

@@ -0,0 +1,67 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/api/basespace_error'
+
+module Bio
+module BaseSpace
+
+# This class can be passed as an optional argument for a filtering getUserProducts list response.
+class QueryParametersPurchasedProduct
+  attr_accessor :passed
+
+  LEGAL = {
+    'Tags'        => [],
+    'ProductIds'  => [],
+  }
+
+  # Create a new QueryParametersPurchasedProduct instance.
+  #
+  # +pars+:: Query parameters used for list filtering.
+  def initialize(pars = {})
+    @passed = {}
+    pars.each do |k, v|
+      @passed[k] = v
+    end
+    validate
+  end
+        
+  # Return a string representation of all query parameters.
+  def to_s
+    return @passed.to_s
+  end
+
+  # Return debugging information of the object.
+  def to_str
+    return self.inspect
+  end
+
+  # Return the query parameters.
+  def get_parameter_dict
+    return @passed
+  end
+
+  # Check if the query parameters are valid.
+  #
+  # Throws UnknownParameterError for illegal parameters.
+  def validate
+    @passed.each do |k, v|
+      raise UnknownParameterError.new(k) unless LEGAL.has_key?(k)
+    end
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+

data/lib/basespace/model/refund_purchase_response.rb

@@ -0,0 +1,40 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# Response of a refund purchase.
+class RefundPurchaseResponse < Model
+
+  # Create a new RefundPurchaseResponse instance.
+  def initialize
+    @swagger_types = {
+      'ResponseStatus'  => 'ResponseStatus',
+      'Response'        => 'Purchase',
+      'Notifications'   => 'list<Str>',
+    }
+    @attributes = {
+      'ResponseStatus'  => nil, # ResponseStatus
+      'Response'        => nil, # Purchase
+      'Notifications'   => nil, # list<Str>
+    }
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+

data/lib/basespace/model/resource_list.rb

@@ -0,0 +1,48 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# Resource list model.
+class ResourceList < Model
+
+  # Create a new ResourceList instance.
+  def initialize
+    @swagger_types = {
+      'Items'           => 'list<Str>',
+      'DisplayedCount'  => 'int',
+      'SortDir'         => 'str',
+      'TotalCount'      => 'int',
+      'Offset'          => 'int',
+      'SortBy'          => 'str',
+      'Limit'           => 'int',
+    }
+    @attributes = {
+      'Items'           => nil, # list<Str>
+      'DisplayedCount'  => nil, # int
+      'SortDir'         => nil, # str
+      'TotalCount'      => nil, # int
+      'Offset'          => nil, # int
+      'SortBy'          => nil, # str
+      'Limit'           => nil, # int
+    }
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+

data/lib/basespace/model/response_status.rb

@@ -0,0 +1,42 @@
+# Copyright 2013 Toshiaki Katayama, Joachim Baran
+#
+#     Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# 
+#     Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'basespace/model'
+
+module Bio
+module BaseSpace
+
+# Response status model.
+class ResponseStatus < Model
+
+  # Create a new ResponseStatus instance.
+  def initialize
+    @swagger_types = {
+      'Message'     => 'str',
+      'Errors'      => 'list<Str>',
+      'ErrorCode'   => 'str',
+      'StackTrace'  => 'str',
+    }
+    @attributes = {
+      'Message'     => nil, # str
+      'Errors'      => nil, # list<Str>
+      'ErrorCode'   => nil, # str
+      'StackTrace'  => nil, # str
+    }
+  end
+
+end
+
+end # module BaseSpace
+end # module Bio
+