zaikio-hub 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71418bf55d46197710099e666b3db5b04fb9e08264b0c21f874f7ea9680dd9b0
-  data.tar.gz: cccda672c5c0149bc602605278b61e28ac2bef9b930e98bf0b17664562a62d2c
+  metadata.gz: 334a558132d7077ca054fbdf5c085025e324d7e37061d5608bcd8e4ab11b8266
+  data.tar.gz: cc234b4c4dbb4dfad4f0fc68cdd58091206057701b7307fa26a2cc18e6ae4705
 SHA512:
-  metadata.gz: e0acec4f0cd530d9f4cb52b49eb53a86bf9aff30a576b02ab0ddd6573c3ef031b97a14ef3d13b451e61f9d7233e0232c4b50ad8bfd9afbeceaaf5d341df09256
-  data.tar.gz: '09c81fcb75e68d73e27ce8b69f2d0bc329b42e0fd7286b8fc0e825df50b40fbfabd1c4f1fd13a344126c79a99a1a52c4e77f70c27f6c26c9f13e40f0cbfcfa90'
+  metadata.gz: c84626e8323410a6d4d4f28302ec04fc18d61ee52347ed281635cbdcc389291f9df274cf4f53e5cbf0b4086da2b478ea28b4c9bd7aa89398f495783432589c7a
+  data.tar.gz: 75cc5d306c754be2f701e629818e65746cf0fef20dd3129af3587be68b8251b7a8b917e008c19a905842da1ed3962ba69eba22c871de431eba2c5f4f386c52c6

data/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2021-08-25
+
+* Added `CurrentOrganization#create_subscription`
+
+## [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`
@@ -53,7 +77,10 @@ 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.0..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

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/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

@@ -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/current_organization.rb

@@ -16,7 +16,7 @@ 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,
                  :granted_oauth_scopes, :requested_oauth_scopes,
@@ -47,6 +47,14 @@ module Zaikio
       def members
         memberships.with_fallback.map(&:person)
       end
+
+      def create_subscription(status: "active", plan_name: nil)
+        if Zaikio::Hub.current_token_data.subject_type == "Organization"
+          result = self.class.request(:post, "organization/subscription",
+                                      subscription: { status: status, plan_name: plan_name })
+          Zaikio::Hub::Subscription.new(result.data)
+        end
+      end
     end
   end
 end

data/lib/zaikio/hub/current_person.rb

@@ -6,7 +6,7 @@ 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,

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
@@ -10,7 +8,7 @@ module Zaikio
       # Attributes
       attributes :updated_at, :created_at, :subscriber_type, :subscriber_id,
                  :status, :app_name, :activated_at, :last_billed_at,
-                 :last_paid_at, :trial_ended_at, :plan, :preceding_plan,
+                 :last_paid_at, :trial_ended_at, :plan, :plan_name, :preceding_plan,
                  :changed_plan_at, :usages_in_current_billing_period
 
       def initialize(attributes = {})

data/lib/zaikio/hub/version.rb

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

data/lib/zaikio/hub.rb

@@ -1,15 +1,12 @@
 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"
 require "zaikio/hub/base"
 require "zaikio/hub/asset"
@@ -73,8 +70,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-hub
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - crispymtn
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -69,7 +69,7 @@ dependencies:
         version: 3.10.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -79,7 +79,7 @@ dependencies:
         version: 3.10.5
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.12.0
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: spyke
   requirement: !ruby/object:Gem::Requirement
@@ -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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Ruby API Client for Zaikio's Hub
 email:
 - op@crispymtn.com
@@ -113,7 +127,6 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/zaikio/error.rb
 - lib/zaikio/hub.rb
 - lib/zaikio/hub/address.rb
 - lib/zaikio/hub/asset.rb
@@ -126,15 +139,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/error.rb

@@ -1,18 +0,0 @@
-module Zaikio
-  class Error < StandardError; end
-
-  class ConnectionError < Zaikio::Error; end
-
-  class ResourceNotFound < Zaikio::Error; end
-end
-
-module Spyke
-  instance_eval do
-    # avoid warning: already initialized constant
-    remove_const("ConnectionError")
-    remove_const("ResourceNotFound")
-  end
-
-  ConnectionError = Class.new Zaikio::ConnectionError
-  ResourceNotFound = Class.new Zaikio::ResourceNotFound
-end

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/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

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"