oktakit 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9909ae42a8aab1535c521ce334ab75809daf340
-  data.tar.gz: d961502c418a988213484c0427e080078ab1719e
+  metadata.gz: 3adab52f184b5c0fba4fd028e4cdff2feab41de2
+  data.tar.gz: c9a1251fb849eb6c7b411bc8d60b911cc6c5f37d
 SHA512:
-  metadata.gz: cbb1128f0b98700c17e9476b46a72c5ce4024962e773b2331d11808432623ea7722f8e082dfec04170fa65b9e6d0621992db59d4e67a678d084a75b045555af1
-  data.tar.gz: 8721eb00c6ea3dc40fa13c980a1b02c4d472198f65dc7b6b6016171e6a8f183fc394bd7e412bbc6c3f2a4da79084d69beb87e6b972500289dbfece6145f8a858
+  metadata.gz: 367d9245869de129a64f7da78e72b4927750489897fdd3607a4a61cb4f658158db91ab5a84428255a6d05cf8b6259ea986213ace723b0ac94022acc676c934bc
+  data.tar.gz: 85facd5085b68c9f007cea04819b83469744175e33c78264129bc9614d5272487f03bee05f925a2488dfba59116d950edd3b414f5a555e3c026999480090dc45

data/.travis.yml

@@ -3,4 +3,5 @@ before_install: gem install bundler
 rvm:
   - '2.1'
   - '2.2'
+  - '2.3.1'
 

data/README.md

@@ -19,7 +19,7 @@ And then execute:
 
 ## Usage
 
-`Oktakit` follow the same patterns as [`Octokit`](https://github.com/octokit/octokit.rb), if you are familiar with it you should feel right at home.
+`Oktakit` follows similar patterns as found in [`Octokit`](https://github.com/octokit/octokit.rb). So if you are familiar with Oktakit, then you should feel right at home.
 
 ```ruby
 client = Oktakit.new(token: 't0k3n', organization: 'my-great-org')

data/lib/oktakit/client.rb

@@ -43,12 +43,28 @@ module Oktakit
     # @param options[:headers] [Hash] Optional. Header params for the request.
     # @param options[:accept] [String] Optional. The content type to accept. Default application/json
     # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
+    # @param options[:paginate] [Boolean] Optional. If true, will auto-paginate Okta's API responses.
     # @param options [Hash] Optional. Body params for request.
     # @return [Sawyer::Resource]
     def get(url, options = {})
-      request :get, url, query: options.delete(:query), headers: options.delete(:headers),
-                         accept: options.delete(:accept), content_type: options.delete(:content_type),
-                         data: options
+      should_paginate = options.delete(:paginate)
+      resp, status, next_page = request :get, url, query: options.delete(:query),
+                                                   headers: options.delete(:headers),
+                                                   accept: options.delete(:accept),
+                                                   content_type: options.delete(:content_type),
+                                                   paginate: should_paginate, data: options
+
+      # If we should paginate, then automatically traverse all next_pages
+      if should_paginate
+        all_objs = [resp]
+        while next_page && resp = next_page.get
+          next_page = resp.rels[:next]
+          all_objs << resp.data
+        end
+        resp = all_objs.flatten
+      end
+
+      [resp, status]
     end
 
     # Make a HTTP POST request
@@ -130,7 +146,7 @@ module Oktakit
 
     private
 
-    def request(method, path, data:, query:, headers:, accept:, content_type:)
+    def request(method, path, data:, query:, headers:, accept:, content_type:, paginate: false)
       options = {}
       options[:query] = query || {}
       options[:headers] = headers || {}
@@ -138,8 +154,11 @@ module Oktakit
       options[:headers][:content_type] = content_type if content_type
 
       uri = URI::Parser.new.escape("/api/v1/" + path.to_s)
-      @last_response = response = sawyer_agent.call(method, uri, data, options)
-      [response.data, response.status]
+      @last_response = resp = sawyer_agent.call(method, uri, data, options)
+
+      response = [resp.data, resp.status]
+      response << resp.rels[:next] if paginate
+      response
     end
 
     def sawyer_agent

data/lib/oktakit/client/factors.rb

@@ -74,7 +74,7 @@ module Oktakit
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
-      # @return [Hash<Sawyer::Resource>] All responses return the enrolled Factor with a status of either PENDING_ACTIVATION or ACTIVE.
+      # @return [Hash<Sawyer::Resource>] The enrolled Factor with a status of either PENDING_ACTIVATION or ACTIVE.
       # @see http://developer.okta.com/docs/api/resources/factors.html#enroll-factor
       # @example
       #   Oktakit.enroll_factor('id')

data/lib/oktakit/client/users.rb

@@ -118,7 +118,7 @@ module Oktakit
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
-      # @return [Hash<Sawyer::Resource>] Returns empty object by default. When sendEmail is false, returns an activation link for the user to set up their account.
+      # @return [Hash<Sawyer::Resource>] Returns empty object by default. If sendEmail is false, a user activation link.
       # @see http://developer.okta.com/docs/api/resources/users.html#activate-user
       # @example
       #   Oktakit.activate_user('id')
@@ -198,7 +198,7 @@ module Oktakit
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
-      # @return [Hash<Sawyer::Resource>] Returns an empty object by default. When sendEmail is false, returns a link for the user to reset their password.
+      # @return [Hash<Sawyer::Resource>] Returns an empty object by default. If sendEmail is false a password reset link
       # @see http://developer.okta.com/docs/api/resources/users.html#reset-password
       # @example
       #   Oktakit.reset_password('id')
@@ -214,7 +214,7 @@ module Oktakit
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
-      # @return [Hash<Sawyer::Resource>] Returns the complete user object by default. When tempPassword is true, returns the temporary password.
+      # @return [Hash<Sawyer::Resource>] Returns the user by default. If tempPassword is true, a temporary password.
       # @see http://developer.okta.com/docs/api/resources/users.html#expire-password
       # @example
       #   Oktakit.expire_password('id')
@@ -246,7 +246,7 @@ module Oktakit
       # @param options[:accept] [String] Optional. The content type to accept. Default application/json
       # @param options[:content_type] [String] Optional. The content type for the request. Default application/json
       # @param options [Hash] Optional. Body params for request.
-      # @return [Hash<Sawyer::Resource>] Returns an empty object by default. When sendEmail is false, returns a link for the user to reset their password.
+      # @return [Hash<Sawyer::Resource>] Returns an empty object by default. If sendEmail is false a password reset link
       # @see http://developer.okta.com/docs/api/resources/users.html#forgot-password
       # @example
       #   Oktakit.forgot_password('id')

data/lib/oktakit/error.rb

@@ -8,27 +8,31 @@ module Oktakit
     # @return [Oktakit::Error]
     def self.from_response(response)
       status = response[:status].to_i
-      if klass =  case status
-                  when 400      then Oktakit::BadRequest
-                  when 401      then Oktakit::Unauthorized
-                  when 403      then Oktakit::Forbidden
-                  when 404      then Oktakit::NotFound
-                  when 405      then Oktakit::MethodNotAllowed
-                  when 406      then Oktakit::NotAcceptable
-                  when 409      then Oktakit::Conflict
-                  when 415      then Oktakit::UnsupportedMediaType
-                  when 422      then Oktakit::UnprocessableEntity
-                  when 400..499 then Oktakit::ClientError
-                  when 500      then Oktakit::InternalServerError
-                  when 501      then Oktakit::NotImplemented
-                  when 502      then Oktakit::BadGateway
-                  when 503      then Oktakit::ServiceUnavailable
-                  when 500..599 then Oktakit::ServerError
-                  end
+      if klass = error(status)
         klass.new(response)
       end
     end
 
+    def self.error(status)
+      case status
+      when 400      then Oktakit::BadRequest
+      when 401      then Oktakit::Unauthorized
+      when 403      then Oktakit::Forbidden
+      when 404      then Oktakit::NotFound
+      when 405      then Oktakit::MethodNotAllowed
+      when 406      then Oktakit::NotAcceptable
+      when 409      then Oktakit::Conflict
+      when 415      then Oktakit::UnsupportedMediaType
+      when 422      then Oktakit::UnprocessableEntity
+      when 400..499 then Oktakit::ClientError
+      when 500      then Oktakit::InternalServerError
+      when 501      then Oktakit::NotImplemented
+      when 502      then Oktakit::BadGateway
+      when 503      then Oktakit::ServiceUnavailable
+      when 500..599 then Oktakit::ServerError
+      end
+    end
+
     def initialize(response = nil)
       @response = response
       super(build_error_message)

data/lib/oktakit/version.rb

@@ -1,3 +1,3 @@
 module Oktakit
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oktakit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Graeme Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer