artikcloud 2.0.5 → 2.0.7

data/lib/artikcloud/models/tasks_status_counts.rb

@@ -0,0 +1,230 @@
+=begin
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+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.
+
+=end
+
+require 'date'
+
+module ArtikCloud
+  # 
+  class TasksStatusCounts
+    # Cancelled
+    attr_accessor :cancelled
+
+    # Complete
+    attr_accessor :complete
+
+    # Processing
+    attr_accessor :processing
+
+    # Requested
+    attr_accessor :requested
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cancelled' => :'CANCELLED',
+        :'complete' => :'COMPLETE',
+        :'processing' => :'PROCESSING',
+        :'requested' => :'REQUESTED'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cancelled' => :'Integer',
+        :'complete' => :'Integer',
+        :'processing' => :'Integer',
+        :'requested' => :'Integer'
+      }
+    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?(:'CANCELLED')
+        self.cancelled = attributes[:'CANCELLED']
+      end
+
+      if attributes.has_key?(:'COMPLETE')
+        self.complete = attributes[:'COMPLETE']
+      end
+
+      if attributes.has_key?(:'PROCESSING')
+        self.processing = attributes[:'PROCESSING']
+      end
+
+      if attributes.has_key?(:'REQUESTED')
+        self.requested = attributes[:'REQUESTED']
+      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?
+      return 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 &&
+          cancelled == o.cancelled &&
+          complete == o.complete &&
+          processing == o.processing &&
+          requested == o.requested
+    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
+      [cancelled, complete, processing, requested].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 = ArtikCloud.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/artikcloud/version.rb

@@ -22,5 +22,5 @@ limitations under the License.
 =end
 
 module ArtikCloud
-  VERSION = "2.0.5"
+  VERSION = "2.0.7"
 end

data/lib/artikcloud.rb

@@ -53,14 +53,22 @@ require 'artikcloud/models/device_reg_confirm_user_response'
 require 'artikcloud/models/device_reg_confirm_user_response_envelope'
 require 'artikcloud/models/device_reg_status_response'
 require 'artikcloud/models/device_reg_status_response_envelope'
+require 'artikcloud/models/device_task'
+require 'artikcloud/models/device_task_update_request'
+require 'artikcloud/models/device_task_update_response'
 require 'artikcloud/models/device_token'
 require 'artikcloud/models/device_token_envelope'
 require 'artikcloud/models/device_type'
 require 'artikcloud/models/device_type_array'
 require 'artikcloud/models/device_type_envelope'
+require 'artikcloud/models/device_type_info'
+require 'artikcloud/models/device_type_info_envelope'
 require 'artikcloud/models/device_types_envelope'
+require 'artikcloud/models/device_types_info'
+require 'artikcloud/models/device_types_info_envelope'
 require 'artikcloud/models/devices_envelope'
 require 'artikcloud/models/error_envelope'
+require 'artikcloud/models/event_feed_data'
 require 'artikcloud/models/export_data'
 require 'artikcloud/models/export_data_array'
 require 'artikcloud/models/export_history_response'
@@ -85,6 +93,9 @@ require 'artikcloud/models/message_id'
 require 'artikcloud/models/message_id_envelope'
 require 'artikcloud/models/message_in'
 require 'artikcloud/models/message_out'
+require 'artikcloud/models/metadata_envelope'
+require 'artikcloud/models/metadata_properties_envelope'
+require 'artikcloud/models/metadata_query_envelope'
 require 'artikcloud/models/non_empty_string'
 require 'artikcloud/models/normalized_action'
 require 'artikcloud/models/normalized_actions_envelope'
@@ -109,6 +120,25 @@ require 'artikcloud/models/snapshots_response_envelope'
 require 'artikcloud/models/tag'
 require 'artikcloud/models/tag_array'
 require 'artikcloud/models/tags_envelope'
+require 'artikcloud/models/task'
+require 'artikcloud/models/task_by_did'
+require 'artikcloud/models/task_by_did_list'
+require 'artikcloud/models/task_by_did_list_envelope'
+require 'artikcloud/models/task_envelope'
+require 'artikcloud/models/task_history'
+require 'artikcloud/models/task_history_list'
+require 'artikcloud/models/task_list'
+require 'artikcloud/models/task_list_envelope'
+require 'artikcloud/models/task_parameters'
+require 'artikcloud/models/task_request'
+require 'artikcloud/models/task_status'
+require 'artikcloud/models/task_status_counts'
+require 'artikcloud/models/task_statuses'
+require 'artikcloud/models/task_statuses_envelope'
+require 'artikcloud/models/task_statuses_history_envelope'
+require 'artikcloud/models/task_update_request'
+require 'artikcloud/models/task_update_response'
+require 'artikcloud/models/tasks_status_counts'
 require 'artikcloud/models/token'
 require 'artikcloud/models/token_info'
 require 'artikcloud/models/token_info_success_response'
@@ -123,6 +153,7 @@ require 'artikcloud/models/web_socket_error'
 # APIs
 require 'artikcloud/api/device_types_api'
 require 'artikcloud/api/devices_api'
+require 'artikcloud/api/devices_management_api'
 require 'artikcloud/api/export_api'
 require 'artikcloud/api/messages_api'
 require 'artikcloud/api/registrations_api'

data/pom.xml

@@ -3,7 +3,7 @@
     <groupId>cloud.artik</groupId>
     <artifactId>RubyArtikCloudClientTests</artifactId>
     <packaging>pom</packaging>
-    <version>2.0.0</version>
+    <version>2.0.6.1</version>
     <name>Ruby Artik Cloud Client</name>
     <build>
         <plugins>

data/spec/api/devices_api_spec.rb

@@ -27,15 +27,8 @@ require 'json'
 # Unit tests for ArtikCloud::DevicesApi
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
-describe 'DevicesApi' do
-  before do
-    # run before each test
-    @instance = ArtikCloud::DevicesApi.new
-  end
-
-  after do
-    # run after each test
-  end
+describe 'DevicesApi', :vcr do
+  let(:instance) { ArtikCloud::DevicesApi.new(API_CLIENT) }
 
   describe 'test an instance of DevicesApi' do
     it 'should create an instact of DevicesApi' do
@@ -98,8 +91,12 @@ describe 'DevicesApi' do
   # @param [Hash] opts the optional parameters
   # @return [PresenceEnvelope]
   describe 'get_device_presence test' do
+    let(:device) { FactoryGirl.create(:device1) }
+
     it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      result = instance.get_device_presence(device.id)
+      expect(result.sdid).to eq device.id
+      expect(result.data.last_seen_on).to_not be_nil
     end
   end
 

data/spec/api/devices_management_api_spec.rb

@@ -0,0 +1,251 @@
+=begin
+#ARTIK Cloud API
+
+#No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 2.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+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.
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ArtikCloud::DevicesManagementApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DevicesManagementApi' do
+  before do
+    # run before each test
+    @instance = ArtikCloud::DevicesManagementApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DevicesManagementApi' do
+    it 'should create an instact of DevicesManagementApi' do
+      expect(@instance).to be_instance_of(ArtikCloud::DevicesManagementApi)
+    end
+  end
+
+  # unit tests for create_tasks
+  # Create a new task for one or more devices
+  # Create a new task for one or more devices
+  # @param task_payload Task object to be created
+  # @param [Hash] opts the optional parameters
+  # @return [TaskEnvelope]
+  describe 'create_tasks test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_server_properties
+  # Deletes a device's properties.
+  # Deletes a device's properties.
+  # @param did Device ID.
+  # @param [Hash] opts the optional parameters
+  # @return [MetadataEnvelope]
+  describe 'delete_server_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_all_by_did
+  # Returns the list of tasks for a particular device id with optional status filter.
+  # Returns the list of tasks for a particular device id with optional status filter.
+  # @param did Device ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :count Max results count.
+  # @option opts [Integer] :offset Result starting offset.
+  # @option opts [String] :status Status filter. Comma-separated statuses.
+  # @option opts [String] :order Sort results by a field. Valid fields: createdOn.
+  # @option opts [String] :sort Sort order. Valid values: asc or desc.
+  # @return [TaskByDidListEnvelope]
+  describe 'get_all_by_did test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_device_types_info
+  # Read a device type device management information.
+  # Read a device type device management information.
+  # @param dtid Device type ID.
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTypesInfoEnvelope]
+  describe 'get_device_types_info test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_manifest_properties
+  # Get a device type's device management manifest properties
+  # Get a device type's device management manifest properties
+  # @param dtid Device Type ID.
+  # @param [Hash] opts the optional parameters
+  # @return [MetadataPropertiesEnvelope]
+  describe 'get_manifest_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_properties
+  # Read a device's properties.
+  # Read a device's properties.
+  # @param did Device ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :include_timestamp Include timestamp.
+  # @return [MetadataEnvelope]
+  describe 'get_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_statuses
+  # Returns the details and status of a task id and the individual statuses of each device id in the list.
+  # Returns the details and status of a task id and the individual statuses of each device id in the list.
+  # @param tid Task ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :count Max results count.
+  # @option opts [Integer] :offset Result starting offset.
+  # @option opts [String] :status Status filter. Comma-separated statuses.
+  # @option opts [String] :dids Devices filter. Comma-separated device IDs.
+  # @return [TaskStatusesEnvelope]
+  describe 'get_statuses test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_statuses_history
+  # Returns the history of the status changes for a specific task id, or for a specific device id in that task.
+  # Returns the history of the status changes for a specific task id, or for a specific device id in that task.
+  # @param tid Task ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :did Device ID. Optional.
+  # @return [TaskStatusesHistoryEnvelope]
+  describe 'get_statuses_history test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_task_by_id
+  # Returns the details and global status of a specific task id.
+  # Returns the details and global status of a specific task id.
+  # @param tid Task ID.
+  # @param [Hash] opts the optional parameters
+  # @return [TaskEnvelope]
+  describe 'get_task_by_id test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_tasks
+  # Returns the all the tasks for a device type.
+  # Returns the all the tasks for a device type.
+  # @param dtid Device Type ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :count Max results count.
+  # @option opts [Integer] :offset Result starting offset.
+  # @option opts [String] :status Status filter. Comma-separated statuses.
+  # @option opts [String] :order Sort results by a field. Valid fields: createdOn.
+  # @option opts [String] :sort Sort order. Valid values: asc or desc.
+  # @return [TaskListEnvelope]
+  describe 'get_tasks test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for query_properties
+  # Query device properties across devices.
+  # Query device properties across devices.
+  # @param dtid Device Type ID.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :count Max results count.
+  # @option opts [Integer] :offset Result starting offset.
+  # @option opts [String] :filter Query filter. Comma-separated key=value pairs
+  # @option opts [BOOLEAN] :include_timestamp Include timestamp.
+  # @return [MetadataQueryEnvelope]
+  describe 'query_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_device_types_info
+  # Updates a device type information
+  # Updates a device type information
+  # @param dtid Device type ID.
+  # @param device_type_info Device type info object to be set
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTypesInfoEnvelope]
+  describe 'update_device_types_info test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_server_properties
+  # Updates a device's server properties.
+  # Updates a device's server properties.
+  # @param did Device ID.
+  # @param device_properties Device properties object to be set
+  # @param [Hash] opts the optional parameters
+  # @return [MetadataEnvelope]
+  describe 'update_server_properties test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_task
+  # Updates a task for all devices - For now just allows changing the state to cancelled.
+  # Updates a task for all devices - For now just allows changing the state to cancelled.
+  # @param tid Task ID.
+  # @param task_update_request Task update request
+  # @param [Hash] opts the optional parameters
+  # @return [TaskUpdateResponse]
+  describe 'update_task test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_task_for_device
+  # Updates a task for a specific device - For now just allows changing the state to cancelled.
+  # Updates a task for a specific device - For now just allows changing the state to cancelled.
+  # @param tid Task ID.
+  # @param did Device ID.
+  # @param device_task_update_request Device task update request
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceTaskUpdateResponse]
+  describe 'update_task_for_device test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end