RubyGems - auth0-ruby - Versions diffs - 0.9 - Mend

auth0-ruby 0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

checksums.yaml +7 -0
data/.bundle/config +2 -0
data/.gitignore +8 -0
data/.rspec +2 -0
data/Gemfile +4 -0
data/Gemfile.lock +68 -0
data/README.md +27 -0
data/Rakefile +9 -0
data/auth0.gemspec +29 -0
data/doc/Auth0.html +153 -0
data/doc/Auth0/Api.html +128 -0
data/doc/Auth0/Api/AuthenticationEndpoints.html +596 -0
data/doc/Auth0/Api/V1.html +192 -0
data/doc/Auth0/Api/V1/Clients.html +440 -0
data/doc/Auth0/Api/V1/Connections.html +506 -0
data/doc/Auth0/Api/V1/Logs.html +366 -0
data/doc/Auth0/Api/V1/Rules.html +439 -0
data/doc/Auth0/Api/V1/Users.html +1617 -0
data/doc/Auth0/BadRequest.html +142 -0
data/doc/Auth0/Client.html +236 -0
data/doc/Auth0/Exception.html +140 -0
data/doc/Auth0/Mixins.html +225 -0
data/doc/Auth0/Mixins/HTTPartyProxy.html +121 -0
data/doc/Auth0/Mixins/Initializer.html +298 -0
data/doc/Auth0/NotFound.html +143 -0
data/doc/Auth0/ServerError.html +142 -0
data/doc/Auth0/Unauthorized.html +143 -0
data/doc/Auth0/Unsupported.html +142 -0
data/doc/Auth0/UserIdIsBlank.html +143 -0
data/doc/Auth0Client.html +235 -0
data/doc/_index.html +347 -0
data/doc/class_list.html +58 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +339 -0
data/doc/file.README.html +103 -0
data/doc/file_list.html +60 -0
data/doc/frames.html +26 -0
data/doc/index.html +103 -0
data/doc/js/app.js +219 -0
data/doc/js/full_list.js +181 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +327 -0
data/doc/top-level-namespace.html +114 -0
data/lib/auth0.rb +8 -0
data/lib/auth0/api/authentication_endpoints.rb +71 -0
data/lib/auth0/api/v1.rb +19 -0
data/lib/auth0/api/v1/clients.rb +48 -0
data/lib/auth0/api/v1/connections.rb +51 -0
data/lib/auth0/api/v1/logs.rb +41 -0
data/lib/auth0/api/v1/rules.rb +44 -0
data/lib/auth0/api/v1/users.rb +163 -0
data/lib/auth0/client.rb +7 -0
data/lib/auth0/exception.rb +18 -0
data/lib/auth0/mixins.rb +13 -0
data/lib/auth0/mixins/httparty_proxy.rb +29 -0
data/lib/auth0/mixins/initializer.rb +25 -0
data/lib/auth0/version.rb +4 -0
data/lib/auth0_client.rb +3 -0
data/spec/lib/auth0/api/authentication_endpoints_spec.rb +56 -0
data/spec/lib/auth0/api/v1/clients_spec.rb +62 -0
data/spec/lib/auth0/api/v1/connections_spec.rb +62 -0
data/spec/lib/auth0/api/v1/logs_spec.rb +46 -0
data/spec/lib/auth0/api/v1/rules_spec.rb +40 -0
data/spec/lib/auth0/api/v1/users_spec.rb +215 -0
data/spec/lib/auth0/client_spec.rb +19 -0
data/spec/lib/auth0/mixins/httparty_proxy_spec.rb +60 -0
data/spec/lib/auth0_client_spec.rb +8 -0
data/spec/spec_helper.rb +18 -0
data/spec/support/dummy_class.rb +7 -0
data/spec/support/dummy_class_for_proxy.rb +4 -0
data/spec/support/stub_response.rb +2 -0
metadata +253 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,114 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.7.6
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!top-level-namespace.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Auth0.html" title="Auth0 (module)">Auth0</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Auth0Client.html" title="Auth0Client (class)">Auth0Client</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Mon Jan 26 03:18:46 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>
+  </body>
+</html>

data/lib/auth0.rb ADDED

@@ -0,0 +1,8 @@
+require "auth0/version"
+require "auth0/mixins"
+require "auth0/exception"
+require "auth0/client"
+require "auth0_client"
+# Namespace for ruby-auth0 logic
+module Auth0
+end

data/lib/auth0/api/authentication_endpoints.rb ADDED

@@ -0,0 +1,71 @@
+module Auth0
+  module Api
+    # {https://auth0.com/docs/auth-api}
+    # Describing functionality of auth0 authentication endpoints
+    module AuthenticationEndpoints
+      # {https://auth0.com/docs/auth-api#!#post--oauth-access_token}
+      def obtain_access_token
+        request_params = {
+            client_id:      @client_id,
+            client_secret:  @client_secret,
+            grant_type:     'client_credentials'
+        }
+        post("/oauth/token", request_params)["access_token"]
+      end
+      # {https://auth0.com/docs/auth-api#!#post--delegation}
+      def delegation(id_token, target, scope = "open_id")
+        request_params = {
+                      client_id:  @client_id,
+                      grant_type: "urn:ietf:params:oauth:grant-type:jwt-bearer",
+                      id_token:   id_token,
+                      target:     target,
+                      scope:      scope
+        }
+        post("/delegation", request_params)
+      end
+      # {https://auth0.com/docs/auth-api#!#post--oauth-ro}
+      def login(username, password, scope = "openid", id_token=nil, connection_name="Username-Password-Authentication")
+        request_params = {
+          client_id:  @client_id,
+          username:   username,
+          password:   password,
+          scope:      scope,
+          connection: connection_name,
+          grand_type: "password",
+          id_token:   id_token
+        }
+        post("/oauth/ro", request_params)
+      end
+      # {https://auth0.com/docs/auth-api#!#post--dbconnections-signup}
+      def signup(email, password, connection_name= "Username-Password-Authentication")
+        request_params = {
+          client_id:  @client_id,
+          email:      email,
+          connection: connection_name,
+          password:   password
+        }
+        post("/dbconnections/signup", request_params)
+      end
+      # {https://auth0.com/docs/auth-api#!#post--dbconnections-change_password}
+      def change_password(email, password, connection_name = "Username-Password-Authentication")
+        request_params = {
+          client_id:  @client_id,
+          email:      email,
+          connection: connection_name,
+          password:   password
+        }
+        post("/dbconnections/change_password", request_params)
+      end
+      # {https://auth0.com/docs/auth-api#!#post--tokeninfo}
+      def token_info(id_token)
+        request_params = { id_token: id_token}
+        post("/tokeninfo", request_params)
+      end
+    end
+  end
+end

data/lib/auth0/api/v1.rb ADDED

@@ -0,0 +1,19 @@
+require "auth0/api/v1/users"
+require "auth0/api/v1/clients"
+require "auth0/api/v1/connections"
+require "auth0/api/v1/rules"
+require "auth0/api/v1/logs"
+module Auth0
+  # Space for all API calls
+  module Api
+    # {https://auth0.com/docs/api}
+    # Describing current functionality of Auth0 API V1
+    module V1
+      include Auth0::Api::V1::Users
+      include Auth0::Api::V1::Connections
+      include Auth0::Api::V1::Clients
+      include Auth0::Api::V1::Rules
+      include Auth0::Api::V1::Logs
+    end
+  end
+end

data/lib/auth0/api/v1/clients.rb ADDED

@@ -0,0 +1,48 @@
+module Auth0
+  module Api
+    module V1
+      # {https://auth0.com/docs/api#applications}
+      module Clients
+        # {https://auth0.com/docs/api#!#get--api-clients}
+        def clients
+          path = "/api/clients"
+          get(path)
+        end
+        alias :get_clients :clients
+        # {https://auth0.com/docs/api#!#post--api-clients}
+        def create_client(name, callbacks="")
+          path = "/api/clients"
+          request_params = {
+                           name: name,
+                           callbacks: callbacks
+                          }
+          post(path, request_params)
+        end
+        # @deprecated use {#patch_client}
+        # {https://auth0.com/docs/api#!#put--api-clients--client-id-}
+        def update_client(name, callbacks="", client_id=@client_id)
+          warn "This endpoint has been deprecated in favor of PUT."
+          path = "/api/clients/#{client_id}"
+          request_params = {
+                            name: name,
+                            callbacks: callbacks
+                         }
+          put(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#patch--api-clients--client-id-}
+        def patch_client(name, callbacks="", client_id=@client_id)
+          path = "/api/clients/#{client_id}"
+          request_params = {
+                            name: name,
+                            callbacks: callbacks
+                         }
+          patch(path, request_params)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v1/connections.rb ADDED

@@ -0,0 +1,51 @@
+module Auth0
+  module Api
+    module V1
+      # {https://auth0.com/docs/api#connections}
+      module Connections
+        # {https://auth0.com/docs/api#!#get--api-connections}
+        def connections
+          get("/api/connections")
+        end
+        alias :get_connections :connections
+        # {https://auth0.com/docs/api#!#get--api-connections--connection-name-}
+        def connection(connection_name)
+          path = "/api/connections/#{connection_name.to_s}"
+          get(path)
+        end
+        alias :get_connection :connection
+        # {https://auth0.com/docs/api#!#delete--api-connections--connection-name-}
+        def delete_connection(connection_name)
+          path = "/api/connections/#{connection_name.to_s}"
+          delete(path)
+        end
+        # {https://auth0.com/docs/api#!#post--api-connections}
+        def create_connection(connection_name, strategy, tenant_domain, domain_aliases=nil)
+          path = "/api/connections"
+          request_params = { name: connection_name,
+                           strategy: strategy,
+                           options: {
+                             tenant_domain: tenant_domain,
+                             domain_aliases: domain_aliases
+                           }
+                          }
+          post(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#put--api-connections--connection-name-}
+        def update_connection(connection_name, tenant_domain, status=true)
+          path = "/api/connections/#{connection_name}"
+          request_params = {  status: status,
+                            options: {
+                              tenant_domain: tenant_domain
+                            }
+                          }
+          put(path, request_params)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v1/logs.rb ADDED

@@ -0,0 +1,41 @@
+module Auth0
+  module Api
+    module V1
+      # {https://auth0.com/docs/api#logs}
+      module Logs
+        # {https://auth0.com/docs/api#!#get--api-logs-page--number--per_page--items--sort--field----1-1--fields--fields--exclude_fields-true-false-}
+        #
+        # {https://auth0.com/docs/api#!#get--api-logs-search--criteria-}
+        #
+        # {https://auth0.com/docs/api#!#get--api-logs-from--checkpointId--take--count-}
+        def logs(options={})
+          acceptable_params = %i(take from search_criteria page per_page sort fields exclude_fields)
+          options.reject! do |key,value|
+            if key.nil? ||\
+               value.nil? ||\
+               !acceptable_params.include?(key.to_sym)
+              warn "#{key} is not in acceptable params list: #{acceptable_params}"
+              true
+            end
+          end
+          path= "/api/logs?"+URI.encode_www_form(options)
+          get(path)
+        end
+        alias :search_logs :logs
+        # {https://auth0.com/docs/api#!#get--api-logs--_id-}
+        def log(id)
+          path = "/api/logs/#{id}"
+          get(path)
+        end
+        # {https://auth0.com/docs/api#!#get--api-users--user_id--logs-page--number--per_page--items-}
+        def user_logs(user_id, page=0, per_page=50)
+          path = "/api/users/#{user_id}/logs?page=#{page}&per_page=#{per_page}"
+          get(path)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v1/rules.rb ADDED

@@ -0,0 +1,44 @@
+module Auth0
+  module Api
+    module V1
+      # https://auth0.com/docs/api#rules
+      module Rules
+        # https://auth0.com/docs/api#!#get--api-rules
+        def rules
+          path = "/api/rules"
+          get(path)
+        end
+        alias :get_rules :rules
+        # https://auth0.com/docs/api#!#post--api-rules
+        def create_rule(name, script, order=nil,status=true)
+          path = "/api/rules"
+          request_params = { name: name,
+                           status: status,
+                           script: script,
+                           order: order
+                          }
+          post(path, request_params)
+        end
+        # https://auth0.com/docs/api#!#put--api-rules--rule-name-
+        def update_rule(name, script, order=nil,status=true)
+          path = "/api/rules/#{name}"
+          request_params = {
+                           status: status,
+                           script: script,
+                           order: order
+                          }
+          put(path, request_params)
+        end
+        # https://auth0.com/docs/api#!#delete--api-rules--rule-name-
+        def delete_rule(name)
+          path = "/api/rules/#{name}"
+          delete(path)
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v1/users.rb ADDED

@@ -0,0 +1,163 @@
+module Auth0
+  module Api
+    module V1
+      # {https://auth0.com/docs/api#users}
+      module Users
+        # {https://auth0.com/docs/api#!#get--api-users}
+        #
+        # {https://auth0.com/docs/api#!#get--api-users-search--criteria-}
+        def users(search=nil)
+          path = "/api/users"
+          path += "?search=#{search.to_s}" unless search.to_s.empty?
+          get(path)
+        end
+        alias :users_search :users
+        alias :get_users :users
+        # {https://auth0.com/docs/api#!#get--api-users--user_id-}
+        def user(user_id)
+          path = "/api/users/#{user_id}"
+          get(path)
+        end
+        alias :get_user :user
+        # {https://auth0.com/docs/api#!#get--api-users--user_id--devices}
+        def user_devices(user_id)
+          path = "/api/users/#{user_id}/devices"
+          get(path)
+        end
+        # {https://auth0.com/docs/api#!#get--api-connections--connection--users}
+        # {https://auth0.com/docs/api#!#get--api-connections--connection--users-search--criteria-}
+        def connection_users(connection_name, search=nil)
+          path = "/api/connections/#{connection_name}/users"
+          path += "?search=#{search.to_s}" unless search.to_s.empty?
+          get(path)
+        end
+        alias :search_connection_users :connection_users
+        # {https://auth0.com/docs/api#!#get--api-enterpriseconnections-users-search--criteria-}
+        def enterpriseconnections_users(search_criteria=nil, per_page=500)
+          path = "/api/enterpriseconnections/users?search=#{search_criteria.to_s}&per_page=#{per_page.to_i.to_s}"
+          get(path)
+        end
+        # {https://auth0.com/docs/api#!#get--api-socialconnections-users-search--criteria-}
+        def socialconnections_users(search_criteria=nil, per_page=500)
+          path =  "/api/socialconnections/users?search=#{search_criteria.to_s}&per_page=#{per_page.to_i.to_s}"
+          get(path)
+        end
+        # {https://auth0.com/docs/api#!#get--api-clients--client-id--users}
+        def client_users(client_id=@client_id)
+          path = "/api/clients/#{client_id}/users"
+          get(path)
+        end
+        # {https://auth0.com/docs/api#!#post--api-users}
+        def create_user(email, password, connection_name, request_params={})
+          options = { email: email, password: password, connection: connection_name }
+          request_params.merge!(options)
+          path = "/api/users"
+          post(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#post--api-users--user_id--send_verification_email}
+        def send_verification_email(user_id)
+          path = "/api/users/#{user_id}/send_verification_email"
+          post(path)
+        end
+        # {https://auth0.com/docs/api#!#post--api-users--user_id--change_password_ticket}
+        def change_password_ticket(user_id, new_password, result_url=nil)
+          request_params = { "newPassword" => new_password, "resultUrl" => result_url }
+          path = "/api/users/#{user_id}/change_password_ticket"
+          post(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#post--api-users--user_id--verification_ticket}
+        def verification_ticket(user_id, result_url=nil)
+          request_params = {"resultUrl" => result_url}
+          path = "/api/users/#{user_id}/verification_ticket"
+          post(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#post--api-users--user_id--publickey}
+        def create_public_key(user_id, device, public_key)
+          path = "/api/users/#{user_id}/public_key"
+          request_params = { device: device, public_key: public_key }
+          post(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#put--api-users--user_id--email}
+        def update_user_email(user_id, email, verify=true)
+          path = "/api/users/#{user_id}/email"
+          request_params = { email: email, verify: verify }
+          put(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#put--api-users--user_id--metadata}
+        # This will overwrite user's metadata, be really carefull, preffer using patch instead
+        def update_user_metadata(user_id, metadata={})
+          path = "/api/users/#{user_id}/metadata"
+          put(path, metadata)
+        end
+        # {https://auth0.com/docs/api#!#put--api-users--user_id--password}
+        def update_user_password(user_id, password, verify=true)
+          path = "/api/users/#{user_id}/password"
+          request_params = { password: password, verify: verify }
+          put(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#put--api-users--email--password}
+        def update_user_password_using_email(email, password, connection_name, verify=true)
+          request_params = {
+            email:      email,
+            password:   password,
+            connection: connection_name,
+            verify:     verify
+          }
+          path = "/api/users/#{email}/password"
+          put(path, request_params)
+        end
+        # {https://auth0.com/docs/api#!#patch--api-users--user_id--metadata}
+        def patch_user_metadata(user_id, metadata={})
+          path = "/api/users/#{user_id}/metadata"
+          patch(path, metadata)
+        end
+        # {https://auth0.com/docs/api#!#delete--api-users}
+        #
+        # This will remove all your users
+        def delete_users
+          path = "/api/users/"
+          delete(path)
+        end
+        # {https://auth0.com/docs/api#!#delete--api-users--user_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/users/#{user_id}"
+          delete(path)
+        end
+        # {https://auth0.com/docs/api#!#delete--api-users--user_id--refresh_tokens--refresh_token-}
+        def revoke_user_refresh_token(user_id, refresh_token)
+          path = "/api/users/#{user_id}/refresh_tokens/#{refresh_token}"
+          delete(path)
+        end
+        # {https://auth0.com/docs/api#!#delete--api-users--user_id--publickey-device--device-}
+        def revoke_user_device_public_key(user_id, device)
+          path = "/api/users/#{user_id}/publickey?device=#{device}"
+          delete(path)
+        end
+      end
+    end
+  end
+end