suggestgrid 0.5.0 → 0.6.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74efcb5c621896270859591dd096feb80c7e61ad
-  data.tar.gz: 08caccdcf163a91e8af51b32c3631136ea7ee466
+  metadata.gz: 1ae22a4953d6727fc05aba2fcf64342fa189d8cd
+  data.tar.gz: c1afcaac1d0fe302293619eeda07a16a6a2b28eb
 SHA512:
-  metadata.gz: aeded01196af01275b1b9842aeb4aae4fe54d31fc8e9737d62b93452ee5583c29049e3291a99189aa88ea35a14b643b610d882d8d4163d749b6e5267fb03dd23
-  data.tar.gz: ce2fa8253a0807b413d710b989e18472a51a6598f4ef5fcb518cebff8608d544b8fb7cfc58e1bc34874e00a17036b179d7526ffb4565dc7699dba3856a366c26
+  metadata.gz: 0a457874f08d75980efce240affb0e5ca966e4bcac183b204f5e82ec17767642c1819d57870b6c17eb21de182a5ddaf7e98ac90e8f8d53add3168540181c8ea0
+  data.tar.gz: a3ad2b56df368fa90beeb8f0c2a17a0f4fcf18b7150d9c5c6d03a11edb1dc6476ddc7d27eae18aaea948f4fbd94c7382e1300c82f146007a5c3c4e22f8d4c609

data/lib/suggestgrid/controllers/action_controller.rb

@@ -138,14 +138,17 @@ module SuggestGrid
     end
 
     # Get actions. Defaut responses will be paged by 10 actios each.
-    # Type, user id, item id, or older than parameters could be provided.
+    # Type, user id, item id, timestamp, or older than parameters could be
+    # provided.
     # The intersection of the provided parameters will be returned.
     # @param [String] type Optional parameter: Get actions of a type.
     # @param [String] user_id Optional parameter: Get actions of a user id.
     # @param [String] item_id Optional parameter: Get actions of an item id.
+    # @param [Long] timestamp Optional parameter: Get actions of a timestamp. At
+    # most one of timestamp or older than could be provided.
     # @param [String] older_than Optional parameter: Get actions older than the
     # given duration, or the given time number. Could be a ISO 8601 duration, or
-    # a Unix time number. Specifications are available at
+    # a Unix timestamp. Specifications are available at
     # https://en.wikipedia.org/wiki/ISO_8601#Durations, or
     # https://en.wikipedia.org/wiki/Unix_time.
     # @param [Long] size Optional parameter: The number of the users response.
@@ -158,6 +161,7 @@ module SuggestGrid
     def get_actions(type = nil,
                     user_id = nil,
                     item_id = nil,
+                    timestamp = nil,
                     older_than = nil,
                     size = nil,
                     from = nil)
@@ -170,6 +174,7 @@ module SuggestGrid
           'type' => type,
           'user_id' => user_id,
           'item_id' => item_id,
+          'timestamp' => timestamp,
           'older_than' => older_than,
           'size' => size,
           'from' => from
@@ -192,6 +197,19 @@ module SuggestGrid
       _context = execute_request(_request)
 
       # Validate response against endpoint and global error codes.
+      if _context.response.status_code == 400
+        raise ErrorResponse.new(
+          'Query error.',
+          _context
+        )
+      elsif _context.response.status_code == 422
+        raise ErrorResponse.new(
+          'No query parameter (user id, item id, timestamp, or older than)' \
+          ' is given. In order to delete all actions, delete the' \
+          ' type.',
+          _context
+        )
+      end
       unless _context.response.status_code.between?(200, 208)
         raise ErrorResponse.new(
           'Unexpected internal error.',
@@ -210,26 +228,32 @@ module SuggestGrid
     # * Type must be provided.
     # * If user id is provided, all actions of the user will be deleted.
     # * If item id is provided, all actions on the item will be deleted.
+    # * If timestamp is provided, all actions with that timestamp will be
+    # deleted.
     # * If older than is provided, all actions older than the timestamp or the
     # duration will be deleted.
     # * If a number of these parameters are provided, the intersection of these
     # parameters will be deleted.
     # * In addition to a type, at least one of these parameters must be
-    # provided. In order to delete all the actions of a type, delete the type.
+    # provided.
+    # * In order to delete all the actions of a type, delete the type.
     # @param [String] type Required parameter: Delete actions of a type. This
     # parameter and at least one other parameter is required.
     # @param [String] user_id Optional parameter: Delete actions of a user id.
     # @param [String] item_id Optional parameter: Delete actions of an item
     # id.
+    # @param [Long] timestamp Optional parameter: Get actions of a timestamp. At
+    # most one of timestamp or older than could be provided.
     # @param [String] older_than Optional parameter: Delete actions older than
     # the given duration, or the given time number. Could be a ISO 8601
-    # duration, or a Unix time number. Specifications are available at
+    # duration, or a Unix timestamp. Specifications are available at
     # https://en.wikipedia.org/wiki/ISO_8601#Durations, or
     # https://en.wikipedia.org/wiki/Unix_time.
     # @return MessageResponse response from the API call
     def delete_actions(type,
                        user_id = nil,
                        item_id = nil,
+                       timestamp = nil,
                        older_than = nil)
       # Prepare query url.
       _query_builder = Configuration.base_uri.dup
@@ -240,6 +264,7 @@ module SuggestGrid
           'type' => type,
           'user_id' => user_id,
           'item_id' => item_id,
+          'timestamp' => timestamp,
           'older_than' => older_than
         },
         array_serialization: Configuration.array_serialization
@@ -262,13 +287,14 @@ module SuggestGrid
       # Validate response against endpoint and global error codes.
       if _context.response.status_code == 400
         raise ErrorResponse.new(
-          'Required user id or item id parameters are missing.',
+          'Query error.',
           _context
         )
       elsif _context.response.status_code == 422
         raise ErrorResponse.new(
-          'No query parameter (user id, item id, or older than) is given.' \
-          ' qIn order to delete all actionsdelete the type.',
+          'No query parameter (user id, item id, timestamp, or older than)' \
+          ' is given. In order to delete all actions, delete the' \
+          ' type.',
           _context
         )
       end

data/spec/swagger.yaml

@@ -2,7 +2,7 @@ swagger: '2.0'
 
 info:
   title: SuggestGrid
-  version: 0.5.0
+  version: 0.6.0-rc.2
   description: Personalization made Simple
   x-codegen-settings:
     appendContentHeaders: true
@@ -652,7 +652,7 @@ paths:
       summary: Gets Actions
       description: |
         Get actions. Defaut responses will be paged by 10 actios each.
-        Type, user id, item id, or older than parameters could be provided.
+        Type, user id, item id, timestamp, or older than parameters could be provided.
         The intersection of the provided parameters will be returned.
       parameters:
         - name: type
@@ -673,11 +673,17 @@ paths:
           required: false
           type: string
           format: id
+        - name: timestamp
+          in: query
+          description: Get actions of a timestamp. At most one of timestamp or older than could be provided.
+          required: false
+          type: integer
+          format: int64
         - name: older_than
           in: query
           description: |
             Get actions older than the given duration, or the given time number.
-            Could be a ISO 8601 duration, or a Unix time number.
+            Could be a ISO 8601 duration, or a Unix timestamp.
             Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
           required: false
           type: string
@@ -704,6 +710,14 @@ paths:
           description: Paged actions response.
           schema:
             $ref: '#/definitions/ActionsResponse'
+        400:
+          description: Query error.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
+        422:
+          description: No query parameter (user id, item id, timestamp, or older than) is given. In order to delete all actions, delete the type.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
         default:
           description: Unexpected internal error.
           schema:
@@ -719,9 +733,11 @@ paths:
         * Type must be provided. 
         * If user id is provided, all actions of the user will be deleted.
         * If item id is provided, all actions on the item will be deleted.
+        * If timestamp is provided, all actions with that timestamp will be deleted.
         * If older than is provided, all actions older than the timestamp or the duration will be deleted.
         * If a number of these parameters are provided, the intersection of these parameters will be deleted.
-        * In addition to a type, at least one of these parameters must be provided. In order to delete all the actions of a type, delete the type.
+        * In addition to a type, at least one of these parameters must be provided.
+        * In order to delete all the actions of a type, delete the type.
       parameters:
         - name: type
           in: query
@@ -741,11 +757,17 @@ paths:
           required: false
           type: string
           format: id
+        - name: timestamp
+          in: query
+          description: Get actions of a timestamp. At most one of timestamp or older than could be provided.
+          required: false
+          type: integer
+          format: int64
         - name: older_than
           in: query
           description: |
             Delete actions older than the given duration, or the given time number.
-            Could be a ISO 8601 duration, or a Unix time number.
+            Could be a ISO 8601 duration, or a Unix timestamp.
             Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
           required: false
           type: string
@@ -755,11 +777,11 @@ paths:
           schema:
             $ref: '#/definitions/MessageResponse'
         400:
-          description: Required user id or item id parameters are missing.
+          description: Query error.
           schema:
             $ref: '#/definitions/ErrorResponse'
         422:
-          description: No query parameter (user id, item id, or older than) is given. qIn order to delete all actionsdelete the type.
+          description: No query parameter (user id, item id, timestamp, or older than) is given. In order to delete all actions, delete the type.
           schema:
             $ref: '#/definitions/ErrorResponse'
         default:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suggestgrid
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0.rc2
 platform: ruby
 authors:
 - SuggestGrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-29 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -154,9 +154,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14