skykick 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eafaae81c547995fd55e21844d23699293636cd2fac1d055c921c16308f340ff
-  data.tar.gz: e67e661fd6da88eab1204aa4680ad82be1cb67cd43e5d56512bd21419be3bba2
+  metadata.gz: c7eb504e67e460c967701af6aeee5480111a27080571dad031543cd2051d4aeb
+  data.tar.gz: 2066d5b75aa42485f0e121b2921dcd826b2103374119f9cd75155a1e9fec2b9d
 SHA512:
-  metadata.gz: e6066c80ada508164d556034e15c5db6a060393d1363deb112583c34ef19572b0a5c8e6bd1727dd293d406f26f3ba0f8c9498be8f5264d2f77000c30b2adfee1
-  data.tar.gz: 85e2993883ad13a33e8d5e90162a61b12e64b346d47f2ea59bb86765cbf61e0ab16e467dc9ea5d3379a384768d8a733993ebfa0ffbd7cc9c3128d363555f2212
+  metadata.gz: d72996b30a489b055633198d433492e6d4ecc60382b6547b4d922dd42bc52f5d676c09903d575e72f23cd902175ba52756c180c70033abd55427e572972d5eda
+  data.tar.gz: 75339902414d3ad99dbc346769471a1bb06d638f3f0cd0da0a0bc94080803d43573ad2595dba2b1bea1efb6c858616f57dfbd013965d41a41d61f871cb831033

data/CHANGELOG.md

@@ -2,3 +2,6 @@
 
 ## [0.1.0] - 2024-02-05
 - Initial release
+
+## [0.1.1] - 2024-02-08
+- Update OData support

data/README.md

@@ -56,7 +56,7 @@ client.login
 ### Backup
 Endpoint for backup related requests 
 ```
-licenses = client.tenant_licenses
+subscriptions = client.subscriptions
 ```
 
 |Resource|API endpoint|
@@ -78,7 +78,8 @@ licenses = client.tenant_licenses
 ### Alerts
 Returns Alerts for a provided Email Migration Order ID or Backup service ID.
 ```
-alerts = client.alerts(subscription_id)
+subscriptions = client.subscriptions
+alerts = client.alerts(subscriptions.first.id)
 
 ```
 

data/lib/skykick/client/alerts.rb

@@ -10,7 +10,7 @@ module Skykick
         # This endpoint supports the following OData query parameters: $top
         # $top - default of 25 and max of 500 
         # this is not implemented
-        get("Alerts/#{id}?$top=500")
+        get_paged("Alerts/#{id}")
       end
 
       # Mark an Alert as complete.

data/lib/skykick/pagination.rb

@@ -0,0 +1,44 @@
+require 'uri'
+require 'json'
+
+module Skykick
+  # Defines HTTP request methods
+  # required attributes format
+  module RequestPagination
+
+    # Skykick uses Odata pagination but unfortunately does not support skipping pages.
+    # Using skip responds with "The query specified in the URI is not valid. Query option 
+    # 'Skip' is not allowed. To allow it, set the 'AllowedQueryOptions' property on 
+    # EnableQueryAttribute or QueryValidationSettings."
+    class ODataPagination
+      attr_reader :offset, :limit, :total
+      def initialize(page_size)
+        @offset = 0
+        @limit = page_size
+        # we always have a first page
+        @total = @limit
+      end
+      def page_options
+        { '$top': @limit, '$skip': @offset }
+        { '$top': @limit }
+      end
+      def next_page!(data)
+        # assume array
+        if data.count
+          @total = data.count
+        else
+          @total = 1 
+        end
+        @offset += @limit
+      end
+
+      def self.data(body) 
+        body
+      end
+      # only single page available
+      def more_pages?
+        @offset == 0
+      end
+    end
+  end
+end

data/lib/skykick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skykick
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/skykick.rb

@@ -1,6 +1,7 @@
 require "wrapi"
 require File.expand_path('skykick/api', __dir__)
 require File.expand_path('skykick/client', __dir__)
+require File.expand_path('skykick/pagination', __dir__)
 require File.expand_path('skykick/version', __dir__)
 
 module Skykick
@@ -9,14 +10,15 @@ module Skykick
 
   DEFAULT_ENDPOINT = 'https://apis.skykick.com'.freeze
   DEFAULT_UA = "Skykick Ruby API wrapper #{Skykick::VERSION}".freeze
+  DEFAULT_PAGINATION = Skykick::RequestPagination::ODataPagination
 
-  # Alias for Skykick::Client.new
   #
   # @return [Skykick::Client]
   def self.client(options = {})
     Skykick::Client.new({
       endpoint: DEFAULT_ENDPOINT,
-      user_agent: DEFAULT_UA
+      user_agent: DEFAULT_UA,
+      pagination_class: DEFAULT_PAGINATION
     }.merge(options))
   end
 
@@ -24,5 +26,6 @@ module Skykick
     super
     self.endpoint = DEFAULT_ENDPOINT
     self.user_agent = DEFAULT_UA
+    self.pagination_class = DEFAULT_PAGINATION
   end
 end

data/skykick.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
   s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'wrapi', "~> 0.1.3"
+  s.add_runtime_dependency 'wrapi', ">= 0.2.0"
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skykick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -28,16 +28,16 @@ dependencies:
   name: wrapi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +99,7 @@ files:
 - lib/skykick/client/alerts.rb
 - lib/skykick/client/backup.rb
 - lib/skykick/connection.rb
+- lib/skykick/pagination.rb
 - lib/skykick/version.rb
 - skykick.gemspec
 homepage: https://rubygems.org/gems/skykick