zaikio-hub 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37396907fc8988823d0bf57d8dcfc78996cb9a7b25e002cd3ea87f69275665ac
-  data.tar.gz: 841126a5089074d2dc542ac8eb6b291f3a03687c0b13418803e1cdf68b051dd7
+  metadata.gz: 71418bf55d46197710099e666b3db5b04fb9e08264b0c21f874f7ea9680dd9b0
+  data.tar.gz: cccda672c5c0149bc602605278b61e28ac2bef9b930e98bf0b17664562a62d2c
 SHA512:
-  metadata.gz: 0303e88a5236f1990573aa18b091385ca386547d297f2a82be273d7b43cb1752f7ec081a3aaff36e6c3c7c4b659b420f6662abd633decc8058e1518a587ca185
-  data.tar.gz: 6206196f9229cc183d7c6eca80c3350e475115c54d8baf9114310844206425f9220431adae1e75ca99368c22ac841b834cb9181ece5486e5bb92ded66f107b99
+  metadata.gz: e0acec4f0cd530d9f4cb52b49eb53a86bf9aff30a576b02ab0ddd6573c3ef031b97a14ef3d13b451e61f9d7233e0232c4b50ad8bfd9afbeceaaf5d341df09256
+  data.tar.gz: '09c81fcb75e68d73e27ce8b69f2d0bc329b42e0fd7286b8fc0e825df50b40fbfabd1c4f1fd13a344126c79a99a1a52c4e77f70c27f6c26c9f13e40f0cbfcfa90'

data/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2020-04-12
+
+* Added pagination features for `Subscription` and `Connection`
+
 ## [0.5.0] - 2020-04-08
 
 * Added `granted_oauth_scopes`, `requested_oauth_scopes`, and `requested_oauth_scopes_waiting_for_approval` to Person and Organization
@@ -49,7 +53,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added subscriptions (migration required)
 
-[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.5.0..HEAD
+[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.0..HEAD
+[0.6.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.5.0..v0.6.0
 [0.5.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.4.1..v0.5.0
 [0.4.1]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.3.0...v0.4.0

data/README.md

@@ -122,7 +122,17 @@ client.test_accounts.create(
 
 ```rb
 Zaikio::Hub.with_basic_auth(client_id, client_secret) do
-  connections = Zaikio::Hub::Connection.all
+  # Iterate through pages
+  Zaikio::Hub::Connection.per_page(10).each_page do |connections|
+    connections.size # e.g. 10
+    connections.total_count
+    connections.total_pages
+  end
+  # Load 2nd page
+  Zaikio::Hub::Connection.per_page(10).page(2)
+  # All
+  all_connections = Zaikio::Hub::Connection.all.each_page.flat_map(&:to_a)
+
   subscription = Zaikio::Hub::Subscription.find("Organization-b1475f65-236c-58b8-96e1-e1778b43beb7")
   subscription.plan # => "advanced"
   subscription.activate!

data/lib/zaikio/hub.rb

@@ -5,6 +5,9 @@ require "zaikio/hub/json_parser"
 require "zaikio/hub/authorization_middleware"
 require "zaikio/hub/basic_auth_middleware"
 
+# Pagination
+require "zaikio/hub/pagination"
+
 # Models
 require "zaikio/error"
 require "zaikio/hub/client"
@@ -70,6 +73,7 @@ module Zaikio
                                       ssl: { verify: configuration.environment != :test }) do |c|
           c.request     :json
           c.response    :logger, configuration&.logger, headers: false
+          c.use         Zaikio::Hub::Pagination::HeaderParser
           c.use         JSONParser
           c.use         AuthorizationMiddleware
           c.use         BasicAuthMiddleware

data/lib/zaikio/hub/connection.rb

@@ -1,6 +1,8 @@
 module Zaikio
   module Hub
     class Connection < Base
+      include Zaikio::Hub::Pagination::Scopes
+
       uri "connections(/:id)"
 
       include_root_in_json :connection

data/lib/zaikio/hub/pagination.rb

@@ -0,0 +1,19 @@
+# adapted from https://github.com/balvig/spyke-kaminari
+
+module Zaikio
+  module Hub
+    module Pagination
+      HEADERS = {
+        total_count: "Total-Count",
+        total_pages: "Total-Pages",
+        current_page: "Current-Page"
+      }.freeze
+
+      METADATA_KEY = :pagination
+    end
+  end
+end
+
+require "zaikio/hub/pagination/scopes"
+require "zaikio/hub/pagination/relation"
+require "zaikio/hub/pagination/header_parser"

data/lib/zaikio/hub/pagination/header_parser.rb

@@ -0,0 +1,25 @@
+module Zaikio
+  module Hub
+    module Pagination
+      class HeaderParser < Faraday::Response::Middleware
+        def on_complete(env)
+          @env = env
+
+          metadata = Zaikio::Hub::Pagination::HEADERS.transform_values do |key|
+            header(key)
+          end
+
+          @env.body[:metadata] ||= {}
+          @env.body[:metadata][Zaikio::Hub::Pagination::METADATA_KEY] = metadata
+        end
+
+        private
+
+        def header(key)
+          value = @env.response_headers[key]
+          value.try(:to_i)
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/hub/pagination/relation.rb

@@ -0,0 +1,41 @@
+module Zaikio
+  module Hub
+    module Pagination
+      class Relation < Spyke::Relation
+        Zaikio::Hub::Pagination::HEADERS.each_key do |symbol|
+          define_method(symbol) do
+            find_some.metadata[Zaikio::Hub::Pagination::METADATA_KEY][symbol]
+          end
+        end
+
+        def first_page?
+          current_page == 1
+        end
+
+        def next_page
+          current_page + 1
+        end
+
+        def last_page?
+          current_page == total_pages
+        end
+
+        def out_of_range?
+          current_page > total_pages
+        end
+
+        def each_page
+          return to_enum(:each_page) unless block_given?
+
+          relation = clone
+          yield relation
+          return if relation.last_page? || relation.out_of_range?
+
+          (relation.next_page..relation.total_pages).each do |number|
+            yield clone.page(number)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/hub/pagination/scopes.rb

@@ -0,0 +1,23 @@
+module Zaikio
+  module Hub
+    module Pagination
+      module Scopes
+        extend ActiveSupport::Concern
+
+        included do
+          %i[page per_page].each do |symbol|
+            scope symbol, ->(value) { where(symbol => value) }
+          end
+        end
+
+        module ClassMethods
+          # Overrides the method included by Spyke::Scoping to return paginated
+          # relations.
+          def all
+            current_scope || Zaikio::Hub::Pagination::Relation.new(self, uri: uri)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zaikio/hub/subscription.rb

@@ -1,6 +1,8 @@
 module Zaikio
   module Hub
     class Subscription < Base
+      include Zaikio::Hub::Pagination::Scopes
+
       uri "subscriptions(/:id)"
 
       include_root_in_json :subscription

data/lib/zaikio/hub/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Hub
-    VERSION = "0.5.0".freeze
+    VERSION = "0.6.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -131,6 +131,10 @@ files:
 - lib/zaikio/hub/membership.rb
 - lib/zaikio/hub/organization.rb
 - lib/zaikio/hub/organization_membership.rb
+- lib/zaikio/hub/pagination.rb
+- lib/zaikio/hub/pagination/header_parser.rb
+- lib/zaikio/hub/pagination/relation.rb
+- lib/zaikio/hub/pagination/scopes.rb
 - lib/zaikio/hub/person.rb
 - lib/zaikio/hub/revoked_access_token.rb
 - lib/zaikio/hub/role.rb