auth0 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f3bb45bf30f872a1dd2eb91a1c61e6a035deb69
-  data.tar.gz: dd7232699e2ead49e80f1ed37024a1931df5aeb2
+  metadata.gz: 5662a97be797b89462c17138a8f056908bbd1bd9
+  data.tar.gz: 9973f4c3a23a12e1888c9da0751030def1259601
 SHA512:
-  metadata.gz: e338485145e37a809f8a3742ef6dbee6e198ab0c0fe2f6569d8dac7406d89a3723854e25baa29456a1a44617efdf7b781f078ec0c673e47591fec2d5bee95ef9
-  data.tar.gz: 6a7b9ef6a8a52184a12c5926a1954ad568a82420ff9d3aa67a3ae7583cc8d6f47520c15fcded1ac10e80ca7fc0209532d54d7aff1dcfa2f219cc781604ceff4e
+  metadata.gz: 972202c41cb9e9f479f50479075daeaa33af13a3ac88ce94bff273267bad13b1f5ef56f03f300f9cd2845f576be9c91204c23dccac11f9a9dd51f5d1639cf316
+  data.tar.gz: cde76230c835cdf52f2e963edbd28bc794efb769c892739bfd70029954b6ad23c25a62b8a10285d21839d7c0fc09a300f005d6ab3cf2fd6147be2413b8761dcb

data/.gitignore

@@ -1,4 +1,5 @@
 bin/
+!examples/ruby-on-rails-api/bin/
 vendor/
 doc/
 .DS_Store

data/.rubocop.yml

@@ -1,6 +1,7 @@
 inherit_from: .rubocop_todo.yml
+Rails:
+  Enabled: true
 AllCops:
- RunRailsCops: true
  Exclude:
    - bin/**/*
    - vendor/**/*

data/.rubocop_todo.yml

@@ -1,7 +1,5 @@
-# Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 15
 
-# Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 121

data/.travis.yml

@@ -1,9 +1,11 @@
+---
 language: ruby
 sudo: false
 cache: bundler
 rvm:
-- 2.1.0
-- 2.2.1
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
 script: "./build_travis.sh"
 after_success: "./deploy_documentation.sh"
 deploy:

data/CHANGELOG.md

@@ -1,29 +1,63 @@
 # Change Log
 
-## [v3.6.1](https://github.com/auth0/ruby-auth0/tree/v3.6.1) (2015-07-09)
+## [v4.1.0](https://github.com/auth0/ruby-auth0/tree/v4.1.0) (2016-07-25)
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.0.0...v4.1.0)
+
+**Closed issues:**
+
+- \#post\_password\_change requires a password for ticket. [\#69](https://github.com/auth0/ruby-auth0/issues/69)
+- Exception messages are ruby hash string literals [\#63](https://github.com/auth0/ruby-auth0/issues/63)
+- Ruby on Rails API issue [\#61](https://github.com/auth0/ruby-auth0/issues/61)
+- Not possible to have V1 and V2 clients at the same time [\#60](https://github.com/auth0/ruby-auth0/issues/60)
+- Be able to control timeout [\#57](https://github.com/auth0/ruby-auth0/issues/57)
+- Version 4 changes [\#54](https://github.com/auth0/ruby-auth0/issues/54)
+- Implement API v2 [\#38](https://github.com/auth0/ruby-auth0/issues/38)
+
+**Merged pull requests:**
+
+- Release 4.1.0 [\#71](https://github.com/auth0/ruby-auth0/pull/71) ([ignaciojonas](https://github.com/ignaciojonas))
+- Use JSON \(result.body\) for exception messages in requests [\#67](https://github.com/auth0/ruby-auth0/pull/67) ([ianks](https://github.com/ianks))
+- fixed rails api doesn't start, now impersionated links works with v2 [\#62](https://github.com/auth0/ruby-auth0/pull/62) ([Amialc](https://github.com/Amialc))
+- Add api v2 log endpoints to the gem [\#59](https://github.com/auth0/ruby-auth0/pull/59) ([LindseyB](https://github.com/LindseyB))
+
+## [v4.0.0](https://github.com/auth0/ruby-auth0/tree/v4.0.0) (2016-02-12)
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.6.1...v4.0.0)
+
+**Closed issues:**
+
+- Update LICENSE [\#47](https://github.com/auth0/ruby-auth0/issues/47)
+- Integration tests [\#15](https://github.com/auth0/ruby-auth0/issues/15)
+
+**Merged pull requests:**
+
+- V2 - Rebased to Master [\#53](https://github.com/auth0/ruby-auth0/pull/53) ([ignaciojonas](https://github.com/ignaciojonas))
+- V2 - Auth Endpoints + Gem deployment [\#50](https://github.com/auth0/ruby-auth0/pull/50) ([ignaciojonas](https://github.com/ignaciojonas))
+- Documentation Style [\#49](https://github.com/auth0/ruby-auth0/pull/49) ([ignaciojonas](https://github.com/ignaciojonas))
+- Update License [\#48](https://github.com/auth0/ruby-auth0/pull/48) ([aguerere](https://github.com/aguerere))
+- API v2 Implementation [\#46](https://github.com/auth0/ruby-auth0/pull/46) ([ignaciojonas](https://github.com/ignaciojonas))
+- Refresh token delegation [\#43](https://github.com/auth0/ruby-auth0/pull/43) ([LindseyB](https://github.com/LindseyB))
+- Fix tests to make build green [\#41](https://github.com/auth0/ruby-auth0/pull/41) ([leosoubeste](https://github.com/leosoubeste))
+- Rubocop Integration [\#39](https://github.com/auth0/ruby-auth0/pull/39) ([ignaciojonas](https://github.com/ignaciojonas))
+- Remove semi-colons in README [\#37](https://github.com/auth0/ruby-auth0/pull/37) ([l4u](https://github.com/l4u))
 
+## [v3.6.1](https://github.com/auth0/ruby-auth0/tree/v3.6.1) (2015-07-09)
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.6.0...v3.6.1)
 
 **Merged pull requests:**
 
 - set the search engine if a query is set [\#36](https://github.com/auth0/ruby-auth0/pull/36) ([taylorfinnell](https://github.com/taylorfinnell))
-
 - email validation is broken by \_, which breaks the tests [\#35](https://github.com/auth0/ruby-auth0/pull/35) ([taylorfinnell](https://github.com/taylorfinnell))
 
 ## [v3.6.0](https://github.com/auth0/ruby-auth0/tree/v3.6.0) (2015-06-01)
-
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.5.0...v3.6.0)
 
 **Merged pull requests:**
 
 - Remove exclude\_fields parameter for getting users [\#34](https://github.com/auth0/ruby-auth0/pull/34) ([hzalaz](https://github.com/hzalaz))
-
 - Add connections [\#33](https://github.com/auth0/ruby-auth0/pull/33) ([taylorfinnell](https://github.com/taylorfinnell))
-
 - Use client header spec as per documentation [\#32](https://github.com/auth0/ruby-auth0/pull/32) ([benschwarz](https://github.com/benschwarz))
 
 ## [v3.5.0](https://github.com/auth0/ruby-auth0/tree/v3.5.0) (2015-05-21)
-
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.4.0...v3.5.0)
 
 **Merged pull requests:**
@@ -31,83 +65,51 @@
 - Client information headers [\#31](https://github.com/auth0/ruby-auth0/pull/31) ([benschwarz](https://github.com/benschwarz))
 
 ## [v3.4.0](https://github.com/auth0/ruby-auth0/tree/v3.4.0) (2015-05-07)
-
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.3.0...v3.4.0)
 
 **Closed issues:**
 
 - Changelog [\#29](https://github.com/auth0/ruby-auth0/issues/29)
-
 - Tag releases [\#16](https://github.com/auth0/ruby-auth0/issues/16)
 
 **Merged pull requests:**
 
 - allow setting impersonation ttl [\#30](https://github.com/auth0/ruby-auth0/pull/30) ([seamusabshere](https://github.com/seamusabshere))
-
 - Fix broken link in README [\#28](https://github.com/auth0/ruby-auth0/pull/28) ([dentarg](https://github.com/dentarg))
 
 ## [v3.3.0](https://github.com/auth0/ruby-auth0/tree/v3.3.0) (2015-04-15)
-
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.2.0...v3.3.0)
 
 **Closed issues:**
 
 - AuthenticationEndpoints should be independent of the V1/V2 API [\#20](https://github.com/auth0/ruby-auth0/issues/20)
-
 - Typo in AuthenticationEndpoints.login [\#17](https://github.com/auth0/ruby-auth0/issues/17)
-
 - Remove generated docs [\#14](https://github.com/auth0/ruby-auth0/issues/14)
-
 - Remove the examples directory from this repository [\#4](https://github.com/auth0/ruby-auth0/issues/4)
 
 **Merged pull requests:**
 
 - Chore integration tests [\#27](https://github.com/auth0/ruby-auth0/pull/27) ([hzalaz](https://github.com/hzalaz))
-
 - allow to pass extra parameters to delegation method [\#23](https://github.com/auth0/ruby-auth0/pull/23) ([Maxim-Filimonov](https://github.com/Maxim-Filimonov))
 
 ## [v3.2.0](https://github.com/auth0/ruby-auth0/tree/v3.2.0) (2015-04-14)
-
 **Merged pull requests:**
 
 - Impersonation [\#26](https://github.com/auth0/ruby-auth0/pull/26) ([dentarg](https://github.com/dentarg))
-
 - Allow to set api\_type to use with salesforce\_api [\#25](https://github.com/auth0/ruby-auth0/pull/25) ([Maxim-Filimonov](https://github.com/Maxim-Filimonov))
-
 - Fixed few issues from issues list [\#22](https://github.com/auth0/ruby-auth0/pull/22) ([offtop](https://github.com/offtop))
-
 - Update readme.md api v2 basic usage example [\#19](https://github.com/auth0/ruby-auth0/pull/19) ([ethancrawford](https://github.com/ethancrawford))
-
 - fix token initialization to prevent nil token value [\#18](https://github.com/auth0/ruby-auth0/pull/18) ([ethancrawford](https://github.com/ethancrawford))
-
 - Make the client work for API v1 [\#13](https://github.com/auth0/ruby-auth0/pull/13) ([dentarg](https://github.com/dentarg))
-
 - Fix typo delegation signature; open\_id =\> openid [\#12](https://github.com/auth0/ruby-auth0/pull/12) ([dentarg](https://github.com/dentarg))
-
 - Make the tests run on Travis CI [\#11](https://github.com/auth0/ruby-auth0/pull/11) ([dentarg](https://github.com/dentarg))
-
 - Added support for API V1 and API V2 [\#9](https://github.com/auth0/ruby-auth0/pull/9) ([offtop](https://github.com/offtop))
-
 - Update README.md [\#8](https://github.com/auth0/ruby-auth0/pull/8) ([pose](https://github.com/pose))
-
 - Make delete user safe [\#5](https://github.com/auth0/ruby-auth0/pull/5) ([dentarg](https://github.com/dentarg))
-
 - Remove the omniauth strategy [\#3](https://github.com/auth0/ruby-auth0/pull/3) ([dentarg](https://github.com/dentarg))
-
 - Fix rspec deprecation warning [\#2](https://github.com/auth0/ruby-auth0/pull/2) ([dentarg](https://github.com/dentarg))
-
 - Add method to access delegation endpoint [\#1](https://github.com/auth0/ruby-auth0/pull/1) ([FrancisPlaza](https://github.com/FrancisPlaza))
 
-- Authendpoint in v2 [\#24](https://github.com/auth0/ruby-auth0/pull/24) ([Maxim-Filimonov](https://github.com/Maxim-Filimonov))
-
-- make AuthenticationEndpoints available to client in v2 mode [\#21](https://github.com/auth0/ruby-auth0/pull/21) ([MungoH](https://github.com/MungoH))
-
-- updated webmock version, updated documentation [\#10](https://github.com/auth0/ruby-auth0/pull/10) ([offtop](https://github.com/offtop))
-
-- Add create user method [\#7](https://github.com/auth0/ruby-auth0/pull/7) ([dentarg](https://github.com/dentarg))
-
-- Add impersonation method [\#6](https://github.com/auth0/ruby-auth0/pull/6) ([dentarg](https://github.com/dentarg))
-
 
 
 \* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/DEPLOYMENT.md

@@ -0,0 +1,5 @@
+```
+bundle install
+bundle exec rake spec
+gem push auth0-X.Y.Z.gem
+```

data/Gemfile

@@ -4,7 +4,7 @@ source 'http://rubygems.org'
 gemspec
 
 group :development do
-  gem 'terminal-notifier-guard', require: false
+  gem 'terminal-notifier-guard', require: false unless ENV['TRAVIS']
   gem 'coveralls', require: false
   gem 'rubocop', require: false
   gem 'yard', require: false

data/README.md

@@ -25,8 +25,9 @@ Using [APIv2](https://auth0.com/docs/api/v2)
 require "auth0"
 
 auth0 = Auth0Client.new(
+  :client_id => "YOUR CLIENT ID"
   :token => "YOUR JWT HERE",
-  :domain => "<YOUR ACCOUNT>.auth0.com"
+  :domain => "<YOUR ACCOUNT>.auth0.com"  
 )
 
 puts auth0.get_users
@@ -40,7 +41,24 @@ require "auth0"
 auth0 = Auth0Client.new(
   :client_id => "YOUR CLIENT ID",
   :client_secret => "YOUR CLIENT SECRET",
-  :domain => "<YOUR ACCOUNT>.auth0.com"
+  :domain => "<YOUR ACCOUNT>.auth0.com",
+  :api_version => "1"
+)
+
+puts auth0.get_users
+```
+
+### Timeout
+You can setup a custom timeout in the Auth0Client. By default it is set to 10 minutes.
+
+```ruby
+require "auth0"
+
+auth0 = Auth0Client.new(
+  :client_id => "YOUR CLIENT ID"
+  :token => "YOUR JWT HERE",
+  :domain => "<YOUR ACCOUNT>.auth0.com",
+  :timeout => 15
 )
 
 puts auth0.get_users

data/Rakefile

@@ -10,7 +10,7 @@ begin
   RuboCop::RakeTask.new(:rubocop)
 
   require 'yard'
-  DOC_FILES = ['lib/auth0/api/v2/*.rb', 'lib/auth0/api/authentication_endpoints.rb']
+  DOC_FILES = ['lib/auth0/api/v2/*.rb', 'lib/auth0/api/authentication_endpoints.rb'].freeze
 
   desc 'Build Documentation'
   YARD::Rake::YardocTask.new(:documentation) do |t|

data/auth0.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = ['support@auth0.com']
   s.homepage    = 'https://github.com/auth0/ruby-auth0'
   s.summary     = 'Auth0 API Client'
-  s.description = 'Ruby client library for the Auth0 API.'
+  s.description = 'Ruby toolkit for Auth0 API https://auth0.com.'
 
   s.rubyforge_project = 'auth0'
 
@@ -18,16 +18,17 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'httmultiparty', '~> 0.3.16'
+  s.add_runtime_dependency 'rest-client', '~> 1.8.0'
 
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'fuubar', '~> 2.0'
-  s.add_development_dependency 'guard-rspec', '~> 4.5'
+  s.add_development_dependency 'guard-rspec', '~> 4.5' unless ENV['TRAVIS']
   s.add_development_dependency 'dotenv-rails', '~> 2.0'
   s.add_development_dependency 'pry', '~> 0.10'
   s.add_development_dependency 'pry-nav', '~> 0.2.4'
   s.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
   s.add_development_dependency 'rack-test', '~> 0.6'
+  s.add_development_dependency 'rack', '~> 1.6.4'
   s.add_development_dependency 'simplecov', '~> 0.9'
   s.add_development_dependency 'faker', '~> 1.4'
   s.add_development_dependency 'yard', '~> 0.8'

data/doc_config/templates/default/layout/html/footer.erb

@@ -80,7 +80,7 @@
           <div class="item">
             <a href="mailto:support@auth0.com">Email Us</a>
           </div>
-          <div class="item item-text">10777 Main Street<br>Suite 204<br>Bellevue, WA   98004</div>
+          <div class="item item-text">10900 NE 8th St.<br>Suite 700<br>Bellevue, WA   98004</div>
         </div>
           <div class="column no-heading">
             <div class="item item-phone-label">Sales</div>

data/examples/ruby-api/.gitignore

@@ -0,0 +1,86 @@
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+.env

data/examples/ruby-api/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# A sample Gemfile
+source 'http://rubygems.org'
+
+# gem "rails"
+gem 'sinatra', '~> 1.4'
+gem 'jwt', '~> 1.5'
+gem 'dotenv'

data/examples/ruby-api/README.md

@@ -0,0 +1,24 @@
+#Auth0 + Ruby API Seed
+
+This is the seed project you need to use if you're going to create a Ruby API. You'll mostly use this API either for a SPA or a Mobile app.
+
+#Running the example
+
+In order to run the example you need to have ruby installed.
+
+You also need to set the ClientSecret and ClientId for your Auth0 app as enviroment variables with the following names respectively: AUTH0_CLIENT_SECRET and AUTH0_CLIENT_ID.
+
+For that, if you just create a file named .env in the directory and set the values like the following, the app will just work:
+
+````bash
+# .env file
+AUTH0_CLIENT_SECRET=myCoolSecret
+AUTH0_CLIENT_ID=myCoolClientId
+````
+
+Once you've set those 2 enviroment variables, run `bundle install`, then run `rackup -p 3001` and try calling [http://localhost:3001/ping](http://localhost:3001/ping)
+
+You can then try to do a GET to [http://localhost:3001/secured/ping](http://localhost:3001/secured/ping) which will throw an error if you don't send the JWT in the header.
+
+__Note:__ if you need to enable cross-origin resource sharing, check out the [sinatra-cors_origin](
+https://github.com/britg/sinatra-cross_origin) gem.

data/examples/ruby-api/config.ru

@@ -0,0 +1,2 @@
+require './main'
+run Sinatra::Application

data/examples/ruby-api/main.rb

@@ -0,0 +1,33 @@
+require 'dotenv'
+require 'jwt'
+require 'sinatra'
+Dotenv.load '.env'
+set :show_exceptions, false
+
+class InvalidTokenError < StandardError
+end
+
+def validate_token(env)
+  auth0_client_id = ENV['AUTH0_CLIENT_ID']
+  auth0_client_secret = ENV['AUTH0_CLIENT_SECRET']
+  authorization = env['HTTP_AUTHORIZATION']
+  raise InvalidTokenError if authorization.nil?
+  decoded_token = JWT.decode(authorization.split(' ').last, JWT.base64url_decode(auth0_client_secret))
+  raise InvalidTokenError if auth0_client_id != decoded_token[0]['aud']
+  'You get this only if authenticated'
+rescue JWT::DecodeError
+  raise InvalidTokenError
+end
+
+error InvalidTokenError do
+  'Invalid token'
+end
+
+get '/secured/ping' do
+  validate_token env
+  'All good. You can see it because token is valid'
+end
+
+get '/ping' do
+  'ping'
+end