zaikio-hub 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a9640d7936210115f20948864594d3c7d27b27fb0258213c5a3d8733dde9491
-  data.tar.gz: 249d78a7f720728047357dd321b721a46f010d6131b21269ed8dd7a81c53a1e2
+  metadata.gz: 41182413d16f0e32529d683822ca39dfdd86e35186ba9197c936e00cb25b3a60
+  data.tar.gz: 975d3e33def4f1dbd77ddb3020ca2d072e142d2f32ba63cb524b8c86f852f3f6
 SHA512:
-  metadata.gz: cfc8d23635b8d32c18cf64994aa84be85ba9dc5041ce6eedf3f4904614dfd4444c5e8f60996b311182281cbadd5a975d6934f736a18d74263525722a6d13024e
-  data.tar.gz: 6e64d3cbc98a528b6c475485a350f32fd1e0ff6a36cd7831955e45bf7a3bfdb418afaf73502aaef76cb1f0f6debe6bf70f68c06b2eb46cfa70d805061e73e46f
+  metadata.gz: 998198e1e90035fbe5bb2f25539d0b27b28f291de13b00784dc7ec4207af18145729284e5dc599839236e20c38c3d1d8b75b42e57ac2e170bbad558dcf212fb6
+  data.tar.gz: 80f7dbe3fe80a6d9699ba96d3794b43b7020d9e874f0d8c43002174f7e4032c0286ee135957eccac419f3867190e227885baa7d3f9a93eebe4df160ab0ae24c3

data/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.2] - 2021-04-27
+
+* Include `id` property in `CurrentPerson#attributes` and `CurrentOrganization#attributes`
+
+## [0.6.1] - 2020-04-12
+
+* Fixed that `each_page` works correctly with client instance
+
+## [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
+* Added `requested_oauth_scopes`, and `requested_oauth_scopes_waiting_for_approval` to Connection
+
+## [0.4.1] - 2020-03-04
+
+* Add `state` property for `Zaikio::Hub::Address` model
+
 ## [0.4.0] - 2020-02-23
 
 ### Changed
@@ -40,7 +61,12 @@ 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.4.0...HEAD
+[Unreleased]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.6.2..HEAD
+[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
+[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
 [0.3.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.2.0...v.0.3.0
 [0.2.0]: https://github.com/zaikio/zaikio-hub-ruby/compare/v0.1.1...v.0.2.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/address.rb

@@ -2,8 +2,14 @@ module Zaikio
   module Hub
     class Address < Base
       # Attributes
-      attributes :addressee, :text, :country_code, :town,
-                 :street_and_number, :zip_code, :addition
+      attributes :addressee,
+                 :addition,
+                 :country_code,
+                 :state,
+                 :street_and_number,
+                 :text,
+                 :town,
+                 :zip_code
 
       # Associations
       belongs_to :site, uri: nil, class_name: "Zaikio::Hub::Site"

data/lib/zaikio/hub/client.rb

@@ -19,6 +19,13 @@ module Zaikio
           result
         end
       end
+
+      def each_page
+        super() do |page|
+          page = RequestWrapper.new(page, @client)
+          yield(page)
+        end
+      end
     end
 
     class Client

data/lib/zaikio/hub/connection.rb

@@ -1,13 +1,16 @@
 module Zaikio
   module Hub
     class Connection < Base
+      include Zaikio::Hub::Pagination::Scopes
+
       uri "connections(/:id)"
 
       include_root_in_json :connection
 
       # Attributes
       attributes :updated_at, :created_at, :connectable_type, :connectable_id,
-                 :app_name, :granted_oauth_scopes
+                 :app_name, :granted_oauth_scopes, :requested_oauth_scopes,
+                 :requested_oauth_scopes_waiting_for_approval
 
       def initialize(attributes = {})
         if attributes["connectable_id"]

data/lib/zaikio/hub/current_organization.rb

@@ -16,9 +16,11 @@ module Zaikio
       include_root_in_json :organization
 
       # Attributes
-      attributes :name, :slug, :logo_url, :connected, :subscription,
+      attributes :id, :name, :slug, :logo_url, :connected, :subscription,
                  :created_at, :updated_at, :country_code, :kinds,
-                 :sections, :currency, :brand_color, :test_account_owner_id
+                 :sections, :currency, :brand_color, :test_account_owner_id,
+                 :granted_oauth_scopes, :requested_oauth_scopes,
+                 :requested_oauth_scopes_waiting_for_approval
 
       # Associations
       has_many :memberships,             class_name: "Zaikio::Hub::Membership",

data/lib/zaikio/hub/current_person.rb

@@ -6,11 +6,12 @@ module Zaikio
       uri "person"
 
       # Attributes
-      attributes :updated_at, :created_at, :first_name, :name, :full_name, :email,
+      attributes :id, :updated_at, :created_at, :first_name, :name, :full_name, :email,
                  :pronoun, :locale, :country_code, :currency, :unit_system, :connected,
                  :test_account_owner_id, :time_zone, :email_confirmed,
                  :two_factor_authentication_enabled, :avatar_url, :subscription,
-                 :accessible_apps
+                 :accessible_apps, :granted_oauth_scopes, :requested_oauth_scopes,
+                 :requested_oauth_scopes_waiting_for_approval
 
       def self.find
         all.find_one

data/lib/zaikio/hub/organization.rb

@@ -8,7 +8,9 @@ module Zaikio
       # Attributes
       attributes :name, :slug, :logo_url, :connected, :subscription,
                  :created_at, :updated_at, :country_code, :kinds,
-                 :sections, :currency, :brand_color, :test_account_owner_id
+                 :sections, :currency, :brand_color, :test_account_owner_id,
+                 :granted_oauth_scopes, :requested_oauth_scopes,
+                 :requested_oauth_scopes_waiting_for_approval
 
       # Associations
       has_many :memberships,             class_name: "Zaikio::Hub::Membership",

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/person.rb

@@ -5,7 +5,9 @@ module Zaikio
       attributes :updated_at, :created_at, :first_name, :name, :full_name, :email,
                  :pronoun, :locale, :country_code, :currency, :unit_system, :connected,
                  :test_account_owner_id, :time_zone, :email_confirmed,
-                 :two_factor_authentication_enabled, :avatar_url, :subscription
+                 :two_factor_authentication_enabled, :avatar_url, :subscription,
+                 :granted_oauth_scopes, :requested_oauth_scopes,
+                 :requested_oauth_scopes_waiting_for_approval
     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.4.0".freeze
+    VERSION = "0.6.2".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-23 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -84,16 +84,22 @@ dependencies:
   name: spyke
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
 description: Ruby API Client for Zaikio's Hub
 email:
 - op@crispymtn.com
@@ -125,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