zaikio-hub 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6bfd7e6c71ab7f1e36f7e636b0669dcf412df73af3a4ea50e9b0ff65b70bd7
-  data.tar.gz: f5aa4039ff6e0a9d0474948445d8a41ac8219d607e5127f4a415b6b547908ceb
+  metadata.gz: 0e562039d2b3f9feb71cd94761df5ee9beb0bb3152d6e87bcf4ee0385a6357a7
+  data.tar.gz: 4302ba8ecdb9493280abf4402e69f9750bb2b3ecd0294d23977bbd748a73082e
 SHA512:
-  metadata.gz: ae95dd113b81078b5d8ebaec510682a1a0c256de6586f46a3cf4ca904128c94bcbe45ad14ffca2deed71b4a911ef5afe9944a83a2299a6fb352b63ac0eb52d55
-  data.tar.gz: d443851cf63f8829dfed8528c7cb4ba3fd2bc4e12492f6e530e4657a9c99d037c3402b66fb12add551d273ebe22882d8d50d5aab731f417cfb83ee40c322b1fb
+  metadata.gz: d75dfed1d42bbffdecffcf1543ecf9d9f98e2ccef507e6f2f56bfe847553e17921619273be2e7eac610f82091ef5eb586db5626d287e0877e531461db01c44e1
+  data.tar.gz: 23babf7a088b8aca679f11241448a8f2d468488cbe6f213dfe7280f186320d739dc6a539411bd3feaac52979d2ed458479cf1138ebe4a3e7ba21525619e60ca4

data/CHANGELOG.md

@@ -7,6 +7,35 @@ 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`
+
+## [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
@@ -44,7 +73,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.1...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
+[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

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,7 +124,16 @@ client.test_accounts.create(
 
 ```rb
 Zaikio::Hub.with_basic_auth(client_id, client_secret) do
-  connections = Zaikio::Hub::Connection.all
+  # 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.to_a
+
   subscription = Zaikio::Hub::Subscription.find("Organization-b1475f65-236c-58b8-96e1-e1778b43beb7")
   subscription.plan # => "advanced"
   subscription.activate!

data/lib/zaikio/hub.rb

@@ -1,7 +1,8 @@
 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"
 
@@ -70,7 +71,8 @@ module Zaikio
                                       ssl: { verify: configuration.environment != :test }) do |c|
           c.request     :json
           c.response    :logger, configuration&.logger, headers: false
-          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/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

@@ -7,7 +7,8 @@ module Zaikio
 
       # 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/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/version.rb

@@ -1,5 +1,5 @@
 module Zaikio
   module Hub
-    VERSION = "0.4.1".freeze
+    VERSION = "0.7.0".freeze
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - crispymtn
 - Jalyna Schröder
 - Martin Spickermann
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 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,7 +140,6 @@ 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
@@ -145,7 +158,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/zaikio/zaikio-hub-ruby/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Ruby API Client for Zaikio's Hub
 test_files: []

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