zaikio-hub 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41182413d16f0e32529d683822ca39dfdd86e35186ba9197c936e00cb25b3a60
-  data.tar.gz: 975d3e33def4f1dbd77ddb3020ca2d072e142d2f32ba63cb524b8c86f852f3f6
+  metadata.gz: 0e562039d2b3f9feb71cd94761df5ee9beb0bb3152d6e87bcf4ee0385a6357a7
+  data.tar.gz: 4302ba8ecdb9493280abf4402e69f9750bb2b3ecd0294d23977bbd748a73082e
 SHA512:
-  metadata.gz: 998198e1e90035fbe5bb2f25539d0b27b28f291de13b00784dc7ec4207af18145729284e5dc599839236e20c38c3d1d8b75b42e57ac2e170bbad558dcf212fb6
-  data.tar.gz: 80f7dbe3fe80a6d9699ba96d3794b43b7020d9e874f0d8c43002174f7e4032c0286ee135957eccac419f3867190e227885baa7d3f9a93eebe4df160ab0ae24c3
+  metadata.gz: d75dfed1d42bbffdecffcf1543ecf9d9f98e2ccef507e6f2f56bfe847553e17921619273be2e7eac610f82091ef5eb586db5626d287e0877e531461db01c44e1
+  data.tar.gz: 23babf7a088b8aca679f11241448a8f2d468488cbe6f213dfe7280f186320d739dc6a539411bd3feaac52979d2ed458479cf1138ebe4a3e7ba21525619e60ca4

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2021-06-18
+
+* **BREAKING** `Relation#all` now fetches all following paginated resources by default
+  (endpoints which don't support pagination are unaffected).
+* **BREAKING** Removed `Relation#each_page` method. You should just use the `all` method now
+  instead:
+
+```diff
+-Model.all.each_page.flat_map(&:to_a)
++Model.all.to_a
+```
+
 ## [0.6.2] - 2021-04-27
 
 * Include `id` property in `CurrentPerson#attributes` and `CurrentOrganization#attributes`
@@ -61,7 +73,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.6.2..HEAD
+[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.7.0..HEAD
+[0.7.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.2..v0.7.0
 [0.6.2]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.1..v0.6.2
 [0.6.1]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.0..v0.6.1
 [0.6.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.5.0..v0.6.0

data/README.md

@@ -46,8 +46,10 @@ token = "..." # Your valid JWT for an organization
 Zaikio::Hub.with_token(token) do
   organization = Zaikio::Hub::CurrentOrganization.new
 
-  # Fetch Data
+  # Fetch data
   organization.memberships.find('abc')
+
+  # Note that .all understands pagination headers and will fetch all pages
   organization.members.all
   organization.machines.all
   organization.software.all
@@ -122,16 +124,15 @@ client.test_accounts.create(
 
 ```rb
 Zaikio::Hub.with_basic_auth(client_id, client_secret) do
-  # 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)
+  # Get total number of records
+  Zaikio::Hub::Connection.per_page(10).total_count
+  #=> 20
+
+  # Fetch just the second page
+  Zaikio::Hub::Connection.per_page(10).page(2).find_some
+
   # All
-  all_connections = Zaikio::Hub::Connection.all.each_page.flat_map(&:to_a)
+  all_connections = Zaikio::Hub::Connection.all.to_a
 
   subscription = Zaikio::Hub::Subscription.find("Organization-b1475f65-236c-58b8-96e1-e1778b43beb7")
   subscription.plan # => "advanced"

data/lib/zaikio/hub.rb

@@ -1,13 +1,11 @@
 require "faraday"
 require "spyke"
+require "zaikio-client-helpers"
+
 require "zaikio/hub/configuration"
-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"
@@ -73,8 +71,8 @@ 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         Zaikio::Client::Helpers::Pagination::FaradayMiddleware
+          c.use         Zaikio::Client::Helpers::JSONParser
           c.use         AuthorizationMiddleware
           c.use         BasicAuthMiddleware
           c.adapter     Faraday.default_adapter

data/lib/zaikio/hub/base.rb

@@ -1,6 +1,8 @@
+require "zaikio/client/model"
+
 module Zaikio
   module Hub
-    class Base < Spyke::Base
+    class Base < Zaikio::Client::Model
       self.callback_methods = { create: :post, update: :patch }.freeze
     end
   end

data/lib/zaikio/hub/connection.rb

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

data/lib/zaikio/hub/subscription.rb

@@ -1,8 +1,6 @@
 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.6.2".freeze
+    VERSION = "0.7.0".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -89,7 +89,7 @@ dependencies:
         version: 5.3.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.5.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,7 +99,21 @@ dependencies:
         version: 5.3.4
     - - "<"
       - !ruby/object:Gem::Version
-        version: 5.5.0
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: zaikio-client-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby API Client for Zaikio's Hub
 email:
 - op@crispymtn.com
@@ -126,15 +140,10 @@ files:
 - lib/zaikio/hub/connection.rb
 - lib/zaikio/hub/current_organization.rb
 - lib/zaikio/hub/current_person.rb
-- lib/zaikio/hub/json_parser.rb
 - lib/zaikio/hub/machine.rb
 - 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

data/lib/zaikio/hub/json_parser.rb

@@ -1,36 +0,0 @@
-require "multi_json"
-
-module Zaikio
-  module Hub
-    class JSONParser < Faraday::Response::Middleware
-      def on_complete(env)
-        connection_error(env) unless /^(2\d\d)|422|404$/.match?(env.status.to_s)
-
-        raise Spyke::ResourceNotFound if env.status.to_s == "404"
-
-        env.body = parse_body(env.body)
-      end
-
-      def connection_error(env)
-        Zaikio::Hub.configuration.logger
-                   .error("Zaikio::Hub Status Code #{env.status}, #{env.body}")
-        raise Spyke::ConnectionError, "Status Code #{env.status}, #{env.body}"
-      end
-
-      def parse_body(body)
-        json = MultiJson.load(body, symbolize_keys: true)
-        {
-          data: json,
-          metadata: {},
-          errors: json.is_a?(Hash) ? json[:errors] : {}
-        }
-      rescue MultiJson::ParseError
-        {
-          data: {},
-          metadata: {},
-          errors: {}
-        }
-      end
-    end
-  end
-end

data/lib/zaikio/hub/pagination.rb

@@ -1,19 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-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

@@ -1,41 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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