auth0-ruby 0.9.1 → 0.10

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Wed Feb  4 17:42:51 2015 by
+  Generated on Mon Feb 23 01:12:53 2015 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.6 (ruby-2.0.0).
 </div>

data/lib/auth0/api/v2.rb

@@ -0,0 +1,19 @@
+require "auth0/api/v2/router"
+require "auth0/api/v2/clients"
+require "auth0/api/v2/users"
+require "auth0/api/v2/blacklists"
+require "auth0/api/v2/jobs"
+require "auth0/api/v2/stats"
+module Auth0
+  module Api
+    # https://auth0.com/docs/apiv2
+    module V2
+      include Auth0::Api::V2::Router
+      include Auth0::Api::V2::Clients
+      include Auth0::Api::V2::Users
+      include Auth0::Api::V2::Blacklists
+      include Auth0::Api::V2::Jobs
+      include Auth0::Api::V2::Stats
+    end
+  end
+end

data/lib/auth0/api/v2/blacklists.rb

@@ -0,0 +1,22 @@
+module Auth0
+  module Api
+    module V2
+      # https://auth0.com/docs/apiv2#!/blacklists
+      module Blacklists
+        # https://auth0.com/docs/apiv2#!/blacklists/get_tokens
+        def blacklisted_tokens
+          get(path)
+        end
+
+        # https://auth0.com/docs/apiv2#!/blacklists/post_tokens
+        def add_token_to_blacklist(jti, aud=nil)
+          request_params = {
+            jti: jti,
+            aud: aud
+          }
+          post(path, request_params)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/clients.rb

@@ -0,0 +1,39 @@
+module Auth0
+  module Api
+    module V2
+      #https://auth0.com/docs/apiv2#!/clients
+      module Clients
+        #https://auth0.com/docs/apiv2#!/clients/get_clients
+        def clients(options={})
+          get(path, options)
+        end
+        alias :get_clients :clients
+
+        #https://auth0.com/docs/apiv2#!/clients/post_clients
+        def create_client(name, options={})
+          request_params = Hash[options.map{|(k,v)| [k.to_sym,v]}]
+          request_params[:name] = name
+          post(path, request_params)
+        end
+
+        #https://auth0.com/docs/apiv2#!/clients/get_clients_by_id
+        def client(client_id, options={})
+          path = "/api/v2/clients/" + client_id.to_s
+          get(path, options)
+        end
+
+        #https://auth0.com/docs/apiv2#!/clients/delete_clients_by_id
+        def delete_client(client_id)
+          path = "/api/v2/clients/" + client_id.to_s
+          delete(path)
+        end
+
+        #https://auth0.com/docs/apiv2#!/clients/patch_clients_by_id
+        def patch_client(client_id, options)
+          path = "/api/v2/clients/" + client_id.to_s
+          patch(path, options)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/jobs.rb

@@ -0,0 +1,20 @@
+module Auth0
+  module Api
+    module V2
+      # https://auth0.com/docs/apiv2#!/jobs
+      module Jobs
+        #https://auth0.com/docs/apiv2#!/jobs/get_jobs_by_job_id
+        def get_job(job_id)
+          path = "/api/v2/jobs/#{job_id}"
+          get(path)
+        end
+
+        # HTTParty doesn't support multipart upload, will move this functionality to a separate PR
+        # https://auth0.com/docs/apiv2#!/jobs/post_users_imports
+        def create_job(users_file, connection_name)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/router.rb

@@ -0,0 +1,28 @@
+module Auth0
+  module Api
+    module V2
+      # Describing all simple routes
+      module Router
+        private
+        # Building simple routes. mb should be removed
+        def path
+          routes = {
+            blacklisted_tokens:       "/api/v2/blacklists/tokens",
+            add_token_to_blacklist:   "/api/v2/blacklists/tokens",
+            clients:                  "/api/v2/clients",
+            get_clients:              "/api/v2/clients",
+            create_client:            "/api/v2/clients",
+            active_users:             "/api/v2/stats/active-users",
+            daily_stats:              "/api/v2/stats/daily",
+            users:                    "/api/v2/users",
+            get_users:                "/api/v2/users",
+            create_user:              "/api/v2/users",
+            delete_users:             "/api/v2/users"
+          }
+          called_method = caller[0][/`.*'/][1..-2]
+          routes[called_method.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/stats.rb

@@ -0,0 +1,22 @@
+module Auth0
+  module Api
+    module V2
+      # https://auth0.com/docs/apiv2#!/stats
+      module Stats
+        #https://auth0.com/docs/apiv2#!/stats/get_active_users
+        def active_users
+          get(path)
+        end
+
+        #https://auth0.com/docs/apiv2#!/stats/get_daily
+        def daily_stats(from, to)
+          request_params = {
+            from: from,
+            to: to
+          }
+          get(path, request_params)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/users.rb

@@ -0,0 +1,64 @@
+module Auth0
+  module Api
+    module V2
+      #https://auth0.com/docs/apiv2#!/users
+      module Users
+        #https://auth0.com/docs/apiv2#!/users/get_users
+        def users( per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, exclude_fields: nil, q: nil )
+          request_params = {  per_page:       per_page,
+                              page:           page,
+                              include_totals: include_totals,
+                              sort:           sort,
+                              connection:     connection,
+                              fields:         fields,
+                              exclude_fields: exclude_fields,
+                              q:              q
+                            }
+          get(path, request_params)
+        end
+        alias :get_users :users
+
+        #https://auth0.com/docs/apiv2#!/users/post_users
+        def create_user(name, options={})
+          request_params = Hash[options.map{|(k,v)| [k.to_sym,v]}]
+          request_params[:name] = name
+          post(path, request_params)
+        end
+
+        #https://auth0.com/docs/apiv2#!/users/delete_users
+        def delete_users
+          delete(path)
+        end
+
+        #https://auth0.com/docs/apiv2#!/users/get_users_by_id
+        def user(user_id, fields: nil, exclude_fields: nil)
+          path = "/api/v2/users/" + user_id.to_s
+          request_params = {  fields:         fields,
+                              exclude_fields: exclude_fields
+                            }
+          get(path, request_params)
+        end
+
+        #https://auth0.com/docs/apiv2#!/users/delete_users_by_id
+        def delete_user(user_id)
+          raise Auth0::UserIdIsBlank, "if you want to remove all users user delete_users method" if user_id.to_s.empty?
+          path = "/api/v2/users/" + user_id.to_s
+          delete(path)
+        end
+
+
+        #https://auth0.com/docs/apiv2#!/users/patch_users_by_id
+        def patch_user(user_id, options)
+          path = "/api/v2/users/" + user_id
+          patch(path, options)
+        end
+
+        #https://auth0.com/docs/apiv2#!/users/delete_multifactor_by_provider
+        def delete_user_provider(user_id, provider_name)
+          path = "/api/v2/users/#{user_id}/multifactor/#{provider_name}"
+          delete(path)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/exception.rb

@@ -15,4 +15,8 @@ class Auth0::ServerError   < Auth0::Exception; end
 # exception for incorrect request, you've sent wrong params
 class Auth0::BadRequest    < Auth0::Exception; end
 # exception for unset user_id, this might cause removal of all users, or other unexpected bahaviour
-class Auth0::UserIdIsBlank   < Auth0::Exception; end
+class Auth0::UserIdIsBlank < Auth0::Exception; end
+# Api v2 access denied
+class Auth0::AccessDenied  < Auth0::Exception; end
+# Invalid parameter passed, e.g. empty where ID is required
+class Auth0::InvalidParameter < Auth0::Exception; end

data/lib/auth0/mixins.rb

@@ -1,13 +1,12 @@
 require 'httparty'
 require 'uri'
-require "auth0/mixins/initializer"
 require "auth0/mixins/httparty_proxy"
+require "auth0/mixins/initializer"
 require "auth0/api/authentication_endpoints"
 require "auth0/api/v1"
+require "auth0/api/v2"
 # Collecting dependencies here
 module Auth0::Mixins
   include Auth0::Mixins::HTTPartyProxy
   include Auth0::Mixins::Initializer
-  include Auth0::Api::AuthenticationEndpoints
-  include Auth0::Api::V1
 end

data/lib/auth0/mixins/httparty_proxy.rb

@@ -6,7 +6,12 @@ module Auth0
       %i(get post put patch delete).each do |method|
         define_method(method) do |path, body={}|
           safe_path = URI.escape(path)
-          result = self.class.send(method, safe_path, body: body.to_json)
+          body = body.delete_if {|k,v| v.nil? }
+          if method == :get
+            result = self.class.send(method, safe_path, query: body)
+          else
+            result = self.class.send(method, safe_path, body: body.to_json)
+          end
           response_body =
             begin
               JSON.parse(result.body.to_s)
@@ -17,6 +22,7 @@ module Auth0
           when 200...226 then response_body
           when 400 then raise Auth0::BadRequest, response_body
           when 401 then raise Auth0::Unauthorized, response_body
+          when 403 then raise Auth0::AccessDenied, response_body
           when 404 then raise Auth0::NotFound, response_body
           when 500 then raise Auth0::ServerError, response_body
           else

data/lib/auth0/mixins/initializer.rb

@@ -5,18 +5,23 @@ module Auth0
       # Default initialization mechanism, moved here to keep Auth0::Client clear
       # accepts hash as parameter
       # you can get all required fields from here: https://auth0.com/docs/auth-api
+      #
+      # To run using api v2, pass protocols: "v2" when creating a client
       def initialize(config)
         options = Hash[config.map{|(k,v)| [k.to_sym,v]}]
-        self.class.base_uri "https://"+options[:namespace].to_s
+        self.class.base_uri "https://#{options[:namespace]}"
         self.class.headers "Content-Type"  => 'application/json'
-        @client_id      = options[:client_id]
-        @client_secret  = options[:client_secret]
-        @token          = obtain_access_token
-        self.class.headers "Authorization" => "Bearer #{@token}"
-        if options[:jwt]
-          require 'auth0/mixins/jwt_operations'
-          self.class.send(:include, Auth0::Mixins::JwtOperations)
+        if options[:protocols].to_s.include?("v2")
+          self.extend Auth0::Api::V2
+          @token = options[:access_token]
+        else
+          self.extend Auth0::Api::V1
+          self.extend Auth0::Api::AuthenticationEndpoints
+          @client_id      = options[:client_id]
+          @client_secret  = options[:client_secret]
+          @token          = obtain_access_token
         end
+        self.class.headers "Authorization" => "Bearer #{options[:access_token]}"
       end
 
       # including initializer in top of klass

data/lib/auth0/version.rb

@@ -1,4 +1,4 @@
 module Auth0
   # current version of gem
-  VERSION = "0.9.1"
+  VERSION = "0.10"
 end

data/spec/lib/auth0/api/v2/blacklists_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+describe Auth0::Api::V2::Blacklists do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Blacklists)
+    dummy_instance.extend(Auth0::Api::V2::Router)
+    @instance = dummy_instance
+  end
+
+  context ".blacklisted_tokens" do
+    it {expect(@instance).to respond_to(:blacklisted_tokens)}
+    it "is expected to call /api/v2/blacklists/tokens" do
+      expect(@instance).to receive(:get).with("/api/v2/blacklists/tokens")
+      expect{@instance.blacklisted_tokens}.not_to raise_error
+    end
+  end
+
+  context ".add_token.to_blacklist" do
+    it {expect(@instance).to respond_to(:add_token_to_blacklist)}
+    it "is expected to call post to /api/v2/blacklists/tokens" do
+      expect(@instance).to receive(:post).with("/api/v2/blacklists/tokens", {aud: "aud", jti: "jti"})
+      @instance.add_token_to_blacklist("jti", "aud")
+    end
+  end
+end

data/spec/lib/auth0/api/v2/clients_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+describe Auth0::Api::V2::Clients do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Router)
+    dummy_instance.extend(Auth0::Api::V2::Clients)
+    @instance = dummy_instance
+  end
+  context ".clients" do
+    it {expect(@instance).to respond_to(:clients)}
+    it {expect(@instance).to respond_to(:get_clients)}
+    it "is expected to send get request to /api/v2/clients/" do
+      expect(@instance).to receive(:get).with("/api/v2/clients", {})
+      expect{@instance.clients}.not_to raise_error
+    end
+    it "is expected to send get request to /api/v2/clients?fields=name&exclude_fields=false" do
+      expect(@instance).to receive(:get).with("/api/v2/clients",{exclude_fields: false, fields: [:name]})
+      expect{@instance.clients({exclude_fields: false, fields: [:name]})}.not_to raise_error
+    end
+  end
+  context ".client" do
+    it {expect(@instance).to respond_to(:client)}
+    it "is expected to send get request to /api/v2/clients/1" do
+      expect(@instance).to receive(:get).with("/api/v2/clients/1", {})
+      expect{@instance.client(1)}.not_to raise_error
+    end
+    it "is expected to send get request to /api/v2/clients?fields=name&exclude_fields=false" do
+      expect(@instance).to receive(:get).with("/api/v2/clients/1",{exclude_fields: false, fields: [:name]})
+      expect{@instance.client(1,{exclude_fields: false, fields: [:name]})}.not_to raise_error
+    end
+  end
+
+  context ".create_client" do
+    it {expect(@instance).to respond_to(:create_client)}
+    it "is expected to send post to /api/v2/clients" do
+      expect(@instance).to receive(:post).with("/api/v2/clients",{name: "name", opt: "opt"})
+      expect{@instance.create_client("name", {name: "/name1", opt: "opt"})}.not_to raise_error
+    end
+  end
+  context ".delete_client" do
+    it {expect(@instance).to respond_to(:delete_client)}
+    it "is expected to send delete to /api/v2/clients/1" do
+      expect(@instance).to receive(:delete).with("/api/v2/clients/1")
+      expect{@instance.delete_client("1")}.not_to raise_error
+    end
+  end
+
+  context ".patch_client" do
+    it {expect(@instance).to respond_to(:patch_client)}
+    it "is expected to send patch to /api/v2/clients/1" do
+      expect(@instance).to receive(:patch).with("/api/v2/clients/1", {fields: "fields"})
+      expect{@instance.patch_client("1", {fields: "fields"})}.not_to raise_error
+    end
+  end
+end

data/spec/lib/auth0/api/v2/jobs_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+describe Auth0::Api::V2::Jobs do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Router)
+    dummy_instance.extend(Auth0::Api::V2::Jobs)
+    @instance = dummy_instance
+  end
+  context ".get_job" do
+    it{expect(@instance).to respond_to(:get_job)}
+    it "expect client to send get to /api/v2/stats/jobs/3" do
+      expect(@instance).to receive(:get).with("/api/v2/jobs/3")
+      expect{@instance.get_job(3)}.not_to raise_error
+    end
+  end
+  context ".daily_stats" do
+    it{expect(@instance).to respond_to(:create_job)}
+    it "expect client to send get to /api/v2/stats/daily" do
+      expect{@instance.create_job("file_name","name")}.to raise_error(NotImplementedError)
+    end
+  end
+end

data/spec/lib/auth0/api/v2/stats_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+describe Auth0::Api::V2::Stats do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Router)
+    dummy_instance.extend(Auth0::Api::V2::Stats)
+    @instance = dummy_instance
+  end
+  context ".active_users" do
+    it{expect(@instance).to respond_to(:active_users)}
+    it "expect client to send get to /api/v2/stats/active-users" do
+      expect(@instance).to receive(:get).with("/api/v2/stats/active-users")
+      expect{@instance.active_users}.not_to raise_error
+    end
+  end
+  context ".daily_stats" do
+    it{expect(@instance).to respond_to(:daily_stats)}
+    it "expect client to send get to /api/v2/stats/daily" do
+      expect(@instance).to receive(:get).with("/api/v2/stats/daily", {from: "20120222", to: "20151222"})
+      expect{@instance.daily_stats("20120222","20151222")}.not_to raise_error
+    end
+  end
+end