auth0 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af6137265bad4b8ee94d95e6f260aa8594614df3
-  data.tar.gz: 42e5145db97b457f3f7127dc880cb27b6d6da959
+  metadata.gz: 5a47592985ca2d564200c14e5b0129e196f609a9
+  data.tar.gz: 938c7174648629d40e948855de95a1531c8245b4
 SHA512:
-  metadata.gz: 0865e559b9dc2b027a03e5b4286cc59870c2271602069306677347b52afdb9419f99ef43291ac024b5dc3023947d965a71024f7f72375754d924bd794916fd3d
-  data.tar.gz: aa6c2e53a3fbe2998c75c932a79178ce953223268c10d7c05a0ab17f51de139ffc217e5a69ba900d0dd87f72d58387f3f0e097d7363c4952a5d191534eb4dfcd
+  metadata.gz: 767338bdf3da7e5f081cde39fe65f742ab0e588087e057b59142e8a1d70f8b281b3dab59d17b8a8071a9e2dd120ac6132fd0b56ed71a027bc67bb2a3088a0b9c
+  data.tar.gz: 21a89cc78706a91f6b503bed30b39b9ac6a9df1ec8b2804fe172034d6049388d77e1334806ae408536bb73631f5b90ae5b74a993e39d834979c9246f2d429cec

data/.bundle/config

@@ -1,2 +1,3 @@
 ---
-BUNDLE_JOBS: 4
+BUNDLE_JOBS: '4'
+BUNDLE_BIN: bin

data/CHANGELOG.md

@@ -1,11 +1,21 @@
 # Change Log
 
-## [Unreleased](https://github.com/auth0/ruby-auth0/tree/HEAD)
+## [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.3.0...HEAD)
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v3.4.0...v3.5.0)
+
+**Merged pull requests:**
+
+- 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:**

data/lib/auth0/api/v2.rb

@@ -3,6 +3,8 @@ require "auth0/api/v2/users"
 require "auth0/api/v2/blacklists"
 require "auth0/api/v2/jobs"
 require "auth0/api/v2/stats"
+require "auth0/api/v2/connections"
+
 module Auth0
   module Api
     # https://auth0.com/docs/apiv2
@@ -12,6 +14,7 @@ module Auth0
       include Auth0::Api::V2::Blacklists
       include Auth0::Api::V2::Jobs
       include Auth0::Api::V2::Stats
+      include Auth0::Api::V2::Connections
     end
   end
 end

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

@@ -0,0 +1,45 @@
+module Auth0
+  module Api
+    module V2
+      module Connections
+        def connections(strategy: nil, fields: nil, include_fields: true)
+          request_params = {
+            strategy: strategy,
+            fields: fields,
+            include_fields: include_fields
+          }
+          path = "/api/v2/connections"
+          get(path, request_params)
+        end
+        alias :get_connections :connections
+
+        def create_connection(body)
+          path = "/api/v2/connections"
+          request_params = body
+          post(path, request_params )
+        end
+
+        def connection(connection_id, fields: nil, include_fields: true)
+          path = "/api/v2/connections/" + connection_id.to_s
+          request_params = {
+            fields:         fields,
+            include_fields: include_fields
+          }
+          get(path, request_params)
+        end
+
+        def delete_connection(connection_id)
+          raise Auth0::MissingConnectionId, "you must specify a connection id" if connection_id.to_s.empty?
+          path = "/api/v2/connections/#{connection_id}"
+          delete(path)
+        end
+
+        def update_connection(connection_id, body)
+          raise Auth0::MissingConnectionId, "you must specify a connection id" if connection_id.to_s.empty?
+          path = "/api/v2/connections/" + connection_id.to_s
+          patch(path, body)
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module Auth0
       #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 )
+        def users( per_page: nil, page: nil, include_totals: nil, sort: nil, connection: nil, fields: nil, q: nil )
           request_params = {
             per_page:       per_page,
             page:           page,
@@ -12,7 +12,6 @@ module Auth0
             sort:           sort,
             connection:     connection,
             fields:         fields,
-            exclude_fields: exclude_fields,
             q:              q
           }
           path = "/api/v2/users"
@@ -35,11 +34,10 @@ module Auth0
         end
 
         #https://auth0.com/docs/apiv2#!/users/get_users_by_id
-        def user(user_id, fields: nil, exclude_fields: nil)
+        def user(user_id, fields: nil)
           path = "/api/v2/users/" + user_id.to_s
           request_params = {
             fields:         fields,
-            exclude_fields: exclude_fields
           }
           get(path, request_params)
         end

data/lib/auth0/exception.rb

@@ -16,6 +16,8 @@ class Auth0::ServerError   < Auth0::Exception; end
 class Auth0::BadRequest    < Auth0::Exception; end
 # exception for unset user_id, this might cause removal of all users, or other unexpected bahaviour
 class Auth0::MissingUserId < Auth0::Exception; end
+# exception for an unset connection_id
+class Auth0::MissingConnectionId < Auth0::Exception; end
 # Api v2 access denied
 class Auth0::AccessDenied  < Auth0::Exception; end
 # Invalid parameter passed, e.g. empty where ID is required

data/lib/auth0/mixins/initializer.rb

@@ -29,12 +29,18 @@ module Auth0
       private
 
       def client_headers(config)
-        sdk_headers = {
-          'Content-Type' => 'application/json',
+        client_info = JSON.dump({name: 'ruby-auth0', version: Auth0::VERSION})
+
+        headers = {
+          'Content-Type' => 'application/json'
         }
-        sdk_headers['User-Agent'] = "Ruby/#{RUBY_VERSION}" if not config[:opt_out_sdk_info]
-        sdk_headers['Auth0-Client'] = "ruby-auth0/#{Auth0::VERSION}" if not config[:opt_out_sdk_info]
-        sdk_headers
+
+        if !config[:opt_out_sdk_info]
+          headers['User-Agent'] = "Ruby/#{RUBY_VERSION}"
+          headers['Auth0-Client'] = Base64.urlsafe_encode64(client_info)
+        end
+
+        headers
       end
 
       def api_domain(options)

data/lib/auth0/version.rb

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

data/spec/integration/lib/auth0/api/v1/api_users_spec.rb

@@ -3,7 +3,7 @@ describe Auth0::Api::V1::Users do
 
   let(:client) { Auth0Client.new(v1_creds) }
   let(:username) { Faker::Internet.user_name }
-  let(:email) { Faker::Internet.safe_email("#{username}#{entity_suffix}") }
+  let(:email) { "#{entity_suffix}#{Faker::Internet.safe_email(username)}" }
   let(:password) { Faker::Internet.password }
   let(:connection) { "Username-Password-Authentication" }
   let!(:user) { client.create_user(email, password, connection, {

data/spec/integration/lib/auth0/api/v2/api_clients_spec.rb

@@ -7,9 +7,9 @@ describe Auth0::Api::V2::Clients do
 
   it { expect(client.clients).to_not be_empty }
 
-  it { expect(client.create_client(client_name, {custom_login_page_off: true})).to include("name" => client_name, "custom_login_page_off" => true) }
+  it { expect(client.create_client(client_name, {custom_login_page_on: false})).to include("name" => client_name, "custom_login_page_on" => false) }
 
-  it { expect(client.patch_client(existing_client["client_id"], {custom_login_page_off: true, sso: true})).to include("custom_login_page_off" => true, "sso" => true) }
+  it { expect(client.patch_client(existing_client["client_id"], {custom_login_page_on: false, sso: true})).to include("custom_login_page_on" => false, "sso" => true) }
 
   it { expect { client.delete_client(existing_client["client_id"]) }.to_not raise_error }
 

data/spec/integration/lib/auth0/api/v2/api_connections_spec.rb

@@ -0,0 +1,71 @@
+require "spec_helper"
+describe Auth0::Api::V2::Connections do
+
+  let(:client) { Auth0Client.new(v2_creds) }
+
+  let(:name) { SecureRandom.uuid[0..25] }
+  let(:strategy) { 'google-oauth2' }
+  let(:options) { {} }
+  let(:enabled_clients) { [] }
+
+  let!(:connection) { client.create_connection({
+    name: name,
+    strategy: strategy,
+    options: options,
+    enabled_clients: enabled_clients,
+  })}
+
+  describe '.connections' do
+
+    let(:connections) { client.connections() }
+
+    it { expect(connections.size).to be > 0 }
+    it { expect(connections.find {|con| con["name"] == name}).to_not be_nil }
+
+    context "#filters" do
+      it { expect(client.connections(strategy: strategy).size).to be > 0 }
+      it { expect(client.connections(strategy: strategy, fields: [:name].join(',')).first).to include("name") }
+      it { expect(client.connections(strategy: strategy, fields: [:name].join(','), include_fields: false).first).to_not include("name") }
+    end
+
+  end
+
+  describe '.connection' do
+
+    let(:subject) { client.connection(connection["id"]) }
+
+    it { should include("name" => connection['name']) }
+
+    context "#filters" do
+      it { expect(client.connection(connection["id"], fields: [:name, :id].join(','))).to include("id", "name") }
+      it { expect(client.connection(connection["id"], fields: [:name, :id].join(','), include_fields: false)).to_not include("id", "name") }
+    end
+
+  end
+
+  describe '.create_connection' do
+
+    let(:subject) { connection }
+
+    it { should include("id", "name") }
+    it { should include(
+      "name" => connection['name'],
+    )}
+
+  end
+
+  describe '.delete_connection' do
+
+    it { expect { client.delete_connection connection["id"] }.to_not raise_error }
+
+    it { expect { client.delete_connection "" }.to raise_error(Auth0::MissingConnectionId) }
+
+  end
+
+
+  describe '.update_connection' do
+    new_name = SecureRandom.uuid[0..25]
+    it { expect(client.update_connection(connection["id"], {"name" => new_name})).to include("name" => new_name) }
+  end
+
+end

data/spec/integration/lib/auth0/api/v2/api_users_spec.rb

@@ -3,7 +3,7 @@ describe Auth0::Api::V2::Users do
 
   let(:client) { Auth0Client.new(v2_creds) }
   let(:username) { Faker::Internet.user_name }
-  let(:email) { Faker::Internet.safe_email("#{username}#{entity_suffix}") }
+  let(:email) { "#{entity_suffix}#{Faker::Internet.safe_email(username)}" }
   let(:password) { Faker::Internet.password }
   let(:connection) { "Username-Password-Authentication" }
   let!(:user) { client.create_user(username, {
@@ -24,7 +24,7 @@ describe Auth0::Api::V2::Users do
     context "#filters" do
       it { expect(client.users(per_page: 1).size).to be 1 }
       it { expect(client.users(per_page: 1, fields: [:picture, :email, :user_id].join(',')).first).to include("email", "user_id", "picture") }
-      it { expect(client.users(per_page: 1, fields: [:picture, :email, :user_id].join(','), exclude_fields: true).first).to_not include("email", "user_id", "picture") }
+      it { expect(client.users(per_page: 1, fields: [:email].join(',')).first).to_not include("user_id", "picture") }
     end
 
   end
@@ -37,7 +37,7 @@ describe Auth0::Api::V2::Users do
 
     context "#filters" do
       it { expect(client.user(user["user_id"], fields: [:picture, :email, :user_id].join(','))).to include("email", "user_id", "picture") }
-      it { expect(client.user(user["user_id"], fields: [:picture, :email, :user_id].join(','), exclude_fields: true)).to_not include("email", "user_id", "picture") }
+      it { expect(client.user(user["user_id"], fields: [:email].join(','))).to_not include("user_id", "picture") }
     end
 
   end

data/spec/integration/lib/auth0/auth0_client_spec.rb

@@ -42,15 +42,32 @@ describe Auth0::Client do
     let(:credentials) { v2_credentials.merge({access_token: ENV["MASTER_JWT"]}) }
   end
 
-  describe "client headers" do
-    let(:access_token) { 'abc123' }
-    let(:domain) { 'myhost.auth0.com' }
-    let(:client) { Auth0::Client.new(v2_credentials.merge({access_token: access_token, domain: domain})) }
-
+  context "client headers" do
+    let(:client) { Auth0::Client.new(v2_credentials.merge({access_token: 'abc123', domain: 'myhost.auth0.com'})) }
     let(:headers) { client.class.headers }
-    specify { expect(headers).to include("Auth0-Client" => "ruby-auth0/#{Auth0::VERSION}") }
-    specify { expect(headers).to include("User-Agent" => "Ruby/#{RUBY_VERSION}") }
-    specify { expect(headers).to include("Authorization" => "Bearer #{access_token}") }
-    specify { expect(headers).to include("Content-Type" => "application/json") }
+
+    let(:base64_token) {
+      Base64.urlsafe_encode64('{"name":"ruby-auth0","version":"'+Auth0::VERSION+'"}')
+    }
+
+    it "has the correct headers present" do
+      expect(headers.keys.sort).to eql ['Auth0-Client', 'Authorization', 'Content-Type', 'User-Agent']
+    end
+
+    it "uses the correct access token" do
+      expect(headers['Authorization']).to eql "Bearer abc123"
+    end
+
+    it "is always json" do
+      expect(headers['Content-Type']).to eql 'application/json'
+    end
+
+    it "sets the ruby version" do
+      expect(headers['User-Agent']).to eql "Ruby/#{RUBY_VERSION}"
+    end
+
+    it "sets the client version" do
+      expect(headers['Auth0-Client']).to eql base64_token
+    end
   end
 end

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

@@ -0,0 +1,70 @@
+require "spec_helper"
+describe Auth0::Api::V2::Connections do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Connections)
+    @instance = dummy_instance
+  end
+
+  context ".connections" do
+    it {expect(@instance).to respond_to(:connections)}
+    it {expect(@instance).to respond_to(:get_connections)}
+
+    it "is expected to call /api/v2/connections" do
+      expect(@instance).to receive(:get).with("/api/v2/connections", {
+        strategy: nil,
+        fields: nil,
+        include_fields: true
+      })
+
+      expect{@instance.connections}.not_to raise_error
+    end
+  end
+
+  context '.create_connection' do
+    it {expect(@instance).to respond_to(:connection)}
+    it {expect(@instance).to respond_to(:create_connection)}
+
+    it "is expected to call /api/v2/connections" do
+      body = double
+      expect(@instance).to receive(:post).with("/api/v2/connections", body)
+
+      expect{@instance.create_connection(body)}.not_to raise_error
+    end
+  end
+
+  context ".connection" do
+    it {expect(@instance).to respond_to(:connection)}
+    it "is expected to call get request to /api/v2/connection/CONNECTION_ID" do
+      expect(@instance).to receive(:get).with("/api/v2/connections/CONNECTION_ID", {fields: nil, include_fields: true})
+      expect{@instance.connection("CONNECTION_ID")}.not_to raise_error
+    end
+  end
+
+  context ".delete_connection" do
+    it {expect(@instance).to respond_to(:delete_connection)}
+    it "is expected to call delete to /api/v2/connections/connectionId" do
+      expect(@instance).to receive(:delete).with("/api/v2/connections/connectionId")
+      @instance.delete_connection("connectionId")
+    end
+
+    it "is expected not to call delete to /api/v2/connections if connection_id is blank" do
+      expect(@instance).not_to receive(:delete)
+      expect{@instance.delete_connection("")}.to raise_exception(Auth0::MissingConnectionId)
+    end
+  end
+
+  context ".update_connection" do
+    it {expect(@instance).to respond_to(:update_connection)}
+    it "is expected to call patch to /api/v2/connections/connectionId" do
+      body = double
+      expect(@instance).to receive(:patch).with("/api/v2/connections/connectionId", body)
+      @instance.update_connection("connectionId", body)
+    end
+
+    it "is expected not to call delete to /api/v2/connections if connection_id is blank" do
+      expect(@instance).not_to receive(:patch)
+      expect{@instance.delete_connection("")}.to raise_exception(Auth0::MissingConnectionId)
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ describe Auth0::Api::V2::Users do
     it {expect(@instance).to respond_to(:users)}
     it {expect(@instance).to respond_to(:get_users)}
     it "is expected to call /api/v2/users" do
-      expect(@instance).to receive(:get).with("/api/v2/users",{:per_page=>nil, :page=>nil, :include_totals=>nil, :sort=>nil, :connection=>nil, :fields=>nil, :exclude_fields=>nil, :q=>nil})
+      expect(@instance).to receive(:get).with("/api/v2/users",{:per_page=>nil, :page=>nil, :include_totals=>nil, :sort=>nil, :connection=>nil, :fields=>nil, :q=>nil})
       expect{@instance.users}.not_to raise_error
     end
   end
@@ -18,7 +18,7 @@ describe Auth0::Api::V2::Users do
   context ".user" do
     it {expect(@instance).to respond_to(:user)}
     it "is expected to call get request to /api/v2/users/USER_ID" do
-      expect(@instance).to receive(:get).with("/api/v2/users/USER_ID", {fields: nil, exclude_fields: nil})
+      expect(@instance).to receive(:get).with("/api/v2/users/USER_ID", {fields: nil})
       expect{@instance.user("USER_ID")}.not_to raise_error
     end
   end

data/spec/lib/auth0/mixins/initializer_spec.rb

@@ -1,29 +1,29 @@
 require "spec_helper"
 
 class MockClass
-  attr_reader :token 
+  attr_reader :token
   include Auth0::Mixins::Initializer
   include HTTParty
 end
 
 describe Auth0::Mixins::Initializer do
   let(:params) { { namespace: 'samples.auth0.com' } }
-  let(:instance) { DummyClassForProxy.include(described_class).new(params) }
+  let(:instance) { DummyClassForProxy.send(:include, described_class).new(params) }
   context 'api v2' do
     before do
       params[:api_version] = 2
     end
-    
+
     it 'sets token when access_token is passed' do
       params[:access_token] = '123'
-      
+
       expect(instance.instance_variable_get('@token')).to eq('123')
     end
 
     it 'sets token when token is passed' do
       params[:token] = '123'
-      
-      expect(instance.instance_variable_get('@token')).to eq('123')  
+
+      expect(instance.instance_variable_get('@token')).to eq('123')
     end
   end
 end

data/spec/spec_helper_full.rb

@@ -29,6 +29,7 @@ RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.include Credentials
   config.after(:suite) do
+    puts "Cleaning up for #{entity_suffix}"
     v2_client = Auth0Client.new({token: ENV["MASTER_JWT"], api_version: 2, domain: ENV["DOMAIN"]})
     v2_client
     .clients
@@ -36,7 +37,8 @@ RSpec.configure do |config|
     .each { |client| v2_client.delete_client(client["client_id"]) }
     v2_client
     .users
-    .select { |user| user["email"].split("@").first.end_with? entity_suffix }
+    .select { |user| user["email"].split("@").first.include? entity_suffix }
     .each { |user| v2_client.delete_user(user["user_id"])}
+    puts "Finished cleaning up for #{entity_suffix}"
   end
 end

data/spec/support/credentials.rb

@@ -1,13 +1,13 @@
 module Credentials
-	def v1_creds
-		{client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"], domain: ENV["DOMAIN"]}
-	end
+  def v1_creds
+    {client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"], domain: ENV["DOMAIN"]}
+  end
 
-	def v1_global_creds
-		{client_id: ENV["GLOBAL_CLIENT_ID"], client_secret: ENV["GLOBAL_CLIENT_SECRET"], domain: ENV["DOMAIN"]}
-	end
+  def v1_global_creds
+    {client_id: ENV["GLOBAL_CLIENT_ID"], client_secret: ENV["GLOBAL_CLIENT_SECRET"], domain: ENV["DOMAIN"]}
+  end
 
-	def v2_creds
-		{token: ENV["MASTER_JWT"], api_version: 2, domain: ENV["DOMAIN"]}
-	end
+  def v2_creds
+    {token: ENV["MASTER_JWT"], api_version: 2, domain: ENV["DOMAIN"]}
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth0
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Auth0
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -232,6 +232,7 @@ files:
 - lib/auth0/api/v2.rb
 - lib/auth0/api/v2/blacklists.rb
 - lib/auth0/api/v2/clients.rb
+- lib/auth0/api/v2/connections.rb
 - lib/auth0/api/v2/jobs.rb
 - lib/auth0/api/v2/stats.rb
 - lib/auth0/api/v2/users.rb
@@ -245,6 +246,7 @@ files:
 - spec/integration/lib/auth0/api/v1/api_clients_spec.rb
 - spec/integration/lib/auth0/api/v1/api_users_spec.rb
 - spec/integration/lib/auth0/api/v2/api_clients_spec.rb
+- spec/integration/lib/auth0/api/v2/api_connections_spec.rb
 - spec/integration/lib/auth0/api/v2/api_users_spec.rb
 - spec/integration/lib/auth0/auth0_client_spec.rb
 - spec/lib/auth0/api/authentication_endpoints_spec.rb
@@ -255,6 +257,7 @@ files:
 - spec/lib/auth0/api/v1/users_spec.rb
 - spec/lib/auth0/api/v2/blacklists_spec.rb
 - spec/lib/auth0/api/v2/clients_spec.rb
+- spec/lib/auth0/api/v2/connections_spec.rb
 - spec/lib/auth0/api/v2/jobs_spec.rb
 - spec/lib/auth0/api/v2/stats_spec.rb
 - spec/lib/auth0/api/v2/users_spec.rb
@@ -296,6 +299,7 @@ test_files:
 - spec/integration/lib/auth0/api/v1/api_clients_spec.rb
 - spec/integration/lib/auth0/api/v1/api_users_spec.rb
 - spec/integration/lib/auth0/api/v2/api_clients_spec.rb
+- spec/integration/lib/auth0/api/v2/api_connections_spec.rb
 - spec/integration/lib/auth0/api/v2/api_users_spec.rb
 - spec/integration/lib/auth0/auth0_client_spec.rb
 - spec/lib/auth0/api/authentication_endpoints_spec.rb
@@ -306,6 +310,7 @@ test_files:
 - spec/lib/auth0/api/v1/users_spec.rb
 - spec/lib/auth0/api/v2/blacklists_spec.rb
 - spec/lib/auth0/api/v2/clients_spec.rb
+- spec/lib/auth0/api/v2/connections_spec.rb
 - spec/lib/auth0/api/v2/jobs_spec.rb
 - spec/lib/auth0/api/v2/stats_spec.rb
 - spec/lib/auth0/api/v2/users_spec.rb