stormpath-sdk 0.4.0 → 1.0.0.beta

data/spec/resource/collection_spec.rb

@@ -0,0 +1,169 @@
+require 'spec_helper'
+
+describe Stormpath::Resource::Collection do
+  let(:href) do
+    'http://example.com'
+  end
+
+  let(:item_class) do
+    Stormpath::Resource::Application
+  end
+
+  let(:client) do
+    Stormpath::Client
+  end
+
+  describe '#collection_href' do
+    context 'by default' do
+      let(:collection) do
+        Stormpath::Resource::Collection.new href, item_class, client
+      end
+
+      it 'defaults to href' do
+        expect(collection.collection_href).to eq href
+      end
+    end
+
+    context 'when specified' do
+      let(:collection_href) do
+        'http://fakie.com'
+      end
+
+      let(:collection) do
+        Stormpath::Resource::Collection.new(
+          href, item_class, client,
+          collection_href: collection_href
+        )
+      end
+
+      it 'defaults to href' do
+        expect(collection.collection_href).to eq collection_href
+      end
+    end
+  end
+
+  describe '#offset' do
+    let(:collection) do
+      Stormpath::Resource::Collection.new href, item_class, client
+    end
+
+    let!(:offset) do
+      collection.offset 5
+    end
+
+    it 'returns the collection' do
+      expect(offset.class).to eq Stormpath::Resource::Collection
+    end
+
+    it 'adds the query to the criteria' do
+      expect(collection.criteria).to include offset: 5
+    end
+  end
+
+  describe '#limit' do
+    let(:collection) do
+      Stormpath::Resource::Collection.new href, item_class, client
+    end
+
+    let!(:limit) do
+      collection.limit 100
+    end
+
+    it 'returns the collection' do
+      expect(limit.class).to eq Stormpath::Resource::Collection
+    end
+
+    it 'adds the query param to the criteria' do
+      expect(collection.criteria).to include limit: 100
+    end
+  end
+
+  describe '#order' do
+    let(:collection) do
+      Stormpath::Resource::Collection.new href, item_class, client
+    end
+
+    let(:order_statement) do
+      'lastName asc,age desc'
+    end
+
+    let!(:order) do
+      collection.order order_statement
+    end
+
+    it 'returns the collection' do
+      expect(order.class).to eq Stormpath::Resource::Collection
+    end
+
+    it 'adds the query param to the criteria' do
+      expect(collection.criteria).to include order_by: order_statement
+    end
+  end
+
+  describe '#search' do
+    let(:collection) do
+      Stormpath::Resource::Collection.new href, item_class, client
+    end
+
+    context 'when passed a string' do
+      let(:query) do
+        'dagnabbit'
+      end
+
+      let!(:search) do
+        collection.search query
+      end
+
+      it 'returns the collection' do
+        expect(search.class).to eq Stormpath::Resource::Collection
+      end
+
+      it 'adds a "q" query string to the criteria' do
+        expect(collection.criteria).to include q: query
+      end
+    end
+
+    context 'when passed a hash of attributes' do
+      let(:query_hash) do
+        { name: 'Stanley Kubrick', description: 'That dude was a sick maniac' }
+      end
+
+      let!(:search) do
+        collection.search query_hash
+      end
+
+      it 'returns the collection' do
+        expect(search.class).to eq Stormpath::Resource::Collection
+      end
+
+      it 'adds a "q" query string to the criteria' do
+        expect(collection.criteria).to include query_hash
+      end
+    end
+  end
+
+  describe '#criteria' do
+    let(:collection) do
+      Stormpath::Resource::Collection.new href, item_class, client
+    end
+
+    context 'when no fetch criteria present' do
+      it 'returns an empty hash for criteria' do
+        expect(collection.criteria).to be_empty
+      end
+    end
+
+    context 'when search, offset, limit and order by are chained' do
+      before do
+        collection.search('Big up to Brooklyn').order('lastName asc').offset(15).limit 50
+      end
+
+      it 'has the search parameters' do
+        expect(collection.criteria).to include q: 'Big up to Brooklyn'
+        expect(collection.criteria).to include offset: 15
+        expect(collection.criteria).to include limit: 50
+        expect(collection.criteria).to include order_by: 'lastName asc'
+      end
+    end
+  end
+end

data/spec/resource/directory_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Stormpath::Resource::Directory, :vcr do
+  describe '#create_account' do
+    let(:directory) { test_directory }
+
+    context 'given a valid account' do
+      let(:account) do
+        Stormpath::Resource::Account.new({
+          email: "test@example.com",
+          given_name: 'Ruby SDK',
+          password: 'P@$$w0rd',
+          surname: 'SDK',
+          username: "username"
+        })
+      end
+
+      let(:created_account) { directory.create_account account, false }
+
+      after do
+        created_account.delete if created_account
+      end
+
+      it 'creates an account' do
+        expect(created_account).to be
+        expect(created_account.username).to eq(account.username)
+      end
+    end
+  end
+end

data/spec/resource/expansion_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Stormpath::Resource::Expansion, :vcr do
+  describe '#initialize' do
+    context 'given a single property name' do
+      let(:expansion) do
+        Stormpath::Resource::Expansion.new 'foo'
+      end
+
+      it 'can be transmuted to a simple hash' do
+        expect(expansion.to_query).to eq({ expand: 'foo' })
+      end
+    end
+    context 'given a list of property names' do
+      let(:expansion) do
+        Stormpath::Resource::Expansion.new 'foo', 'bar'
+      end
+
+      it 'can be transmuted to a simple hash' do
+        expect(expansion.to_query).to eq({ expand: 'foo,bar' })
+      end
+    end
+
+    context 'given no arguments are passed to constructor' do
+      let(:expansion) do
+        Stormpath::Resource::Expansion.new
+      end
+
+      it 'will transmute to an empty hash' do
+        expect(expansion.to_query).to be_nil
+      end
+    end
+  end
+
+  describe "#add_property" do
+    context 'given a simple property name' do
+      let(:expansion) { Stormpath::Resource::Expansion.new }
+
+      before do
+        expansion.add_property :foo
+      end
+
+      it 'can be transmuted to a simple hash' do
+        expect(expansion.to_query).to eq({ expand: 'foo' })
+      end
+    end
+
+    context 'given two simple property names' do
+      let(:expansion) { Stormpath::Resource::Expansion.new }
+
+      before do
+        expansion.add_property :foo
+        expansion.add_property :bar
+      end
+
+      it 'can be transmuted to a simple hash' do
+        expect(expansion.to_query).to eq({ expand: 'foo,bar' })
+      end
+    end
+
+    context 'given a duplicate property name' do
+      let(:expansion) { Stormpath::Resource::Expansion.new }
+
+      before do
+        expansion.add_property :foo
+        expansion.add_property :bar
+        expansion.add_property :bar
+      end
+
+      it 'will not duplicate the property' do
+        expect(expansion.to_query).to eq({ expand: 'foo,bar' })
+      end
+    end
+
+    context 'given a property name, offset, and limit' do
+      let(:expansion) { Stormpath::Resource::Expansion.new }
+
+      before do
+        expansion.add_property :foo, offset: 5, limit: 100
+      end
+
+      it 'can be transmuted to a simple hash' do
+        expect(expansion.to_query).to eq({ expand: 'foo(offset:5,limit:100)' })
+      end
+    end
+
+    context 'given two calls to add the same property' do
+      let(:expansion) { Stormpath::Resource::Expansion.new }
+
+      before do
+        expansion.add_property :foo, offset: 5, limit: 100
+        expansion.add_property :foo, offset: 25
+      end
+
+      it 'allows the last call to win out over the first' do
+        expect(expansion.to_query).to eq({ expand: 'foo(offset:25)' })
+      end
+    end
+  end
+end

data/spec/resource/group_spec.rb

@@ -0,0 +1,49 @@
+
+require 'spec_helper'
+
+describe Stormpath::Resource::Group, :vcr do
+  describe '#add_account' do
+    context "given an account" do
+      let(:directory) do
+        test_api_client.directories.create name: 'testDirectory'
+      end
+
+      let(:group) do
+        directory.groups.create name: 'someGroup'
+      end
+
+      let(:account) do
+        directory.accounts.create({
+          email: 'rubysdk@example.com',
+          given_name: 'Ruby SDK',
+          password: 'P@$$w0rd',
+          surname: 'SDK',
+          username: 'rubysdk'
+        })
+      end
+
+      let(:reloaded_account) do
+        test_api_client.accounts.get account.href
+      end
+
+      let(:reloaded_group) do
+        test_api_client.groups.get group.href
+      end
+
+      before do
+        group.add_account account
+      end
+
+      after do
+        group.delete if group
+        directory.delete if directory
+        account.delete if account
+      end
+
+      it "adds the account to the group" do
+        found = reloaded_group.accounts.find { |a| a.href == account.href }
+        expect(found).to be
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,135 @@
+# Note: If SimpleCov starts after your application code is already loaded (via require),
+# it won't be able to track your files and their coverage! The SimpleCov.start must be
+# issued before any of your application code is required!
+require 'simplecov'
+SimpleCov.start
+
+require 'stormpath-sdk'
+require 'pry'
+require 'pry-debugger'
+require 'webmock/rspec'
+require 'vcr'
+require_relative '../support/api.rb'
+
+Dir['./spec/support/*.rb'].each { |file| require file }
+
+HIJACK_HTTP_REQUESTS_WITH_VCR = ENV['STORMPATH_SDK_TEST_ENVIRONMENT'] != 'CI'
+
+WebMock.allow_net_connect!
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.ignore_request { |r| HIJACK_HTTP_REQUESTS_WITH_VCR != true }
+end
+
+module Stormpath
+  module TestApiKeyHelpers
+    TEST_ENV_REQUIRED_VARS = {
+      STORMPATH_SDK_TEST_API_KEY_ID: 'The id form your Stormpath API Key',
+      STORMPATH_SDK_TEST_API_KEY_SECRET: 'The secret from your Stormpath API Key',
+      STORMPATH_SDK_TEST_APPLICATION_URL: 'The REST URL of a Stormpath Application reserved for testing.',
+      STORMPATH_SDK_TEST_DIRECTORY_URL: 'The REST URL of a Stormpath Directory associated to the test Application.',
+      STORMPATH_SDK_TEST_DIRECTORY_WITH_VERIFICATION_URL: 'The REST URL of a Stormpath Directory configured for email verification, associated to the test Application.'
+    }
+
+    def test_api_key_id
+      ENV['STORMPATH_SDK_TEST_API_KEY_ID']
+    end
+
+    def test_api_key_secret
+      ENV['STORMPATH_SDK_TEST_API_KEY_SECRET']
+    end
+
+    def test_directory_url
+      ENV['STORMPATH_SDK_TEST_DIRECTORY_URL']
+    end
+
+    def test_directory_with_verification_url
+      ENV['STORMPATH_SDK_TEST_DIRECTORY_WITH_VERIFICATION_URL']
+    end
+
+    def test_application_url
+      ENV['STORMPATH_SDK_TEST_APPLICATION_URL']
+    end
+
+    def test_api_key
+      Stormpath::ApiKey.new test_api_key_id,
+        test_api_key_secret
+    end
+
+    def test_api_client
+      Stormpath::Client.new api_key: test_api_key
+    end
+
+    def test_missing_env_vars
+      TEST_ENV_REQUIRED_VARS.reject do |var, message|
+        ENV[var.to_s]
+      end
+    end
+
+    def test_application
+      test_api_client.applications.get test_application_url
+    end
+
+    def test_directory
+      test_api_client.directories.get test_directory_url
+    end
+
+    def test_directory_with_verification
+      test_api_client.directories.get test_directory_with_verification_url
+    end
+  end
+
+  module TestResourceHelpers
+    def destroy_all_stormpath_test_resources
+      Stormpath::Support::Api.destroy_resources(
+        test_api_key_id, test_api_key_secret, test_application_url,
+        test_directory_url, test_directory_with_verification_url
+      )
+    end
+
+    def build_account(opts={})
+      opts.tap do |o|
+        o[:surname]    = (!opts[:surname].blank? && opts[:surname]) || 'surname'
+        o[:given_name] = (!opts[:given_name].blank? && opts[:given_name]) || 'givenname'
+        o[:username]   = (!opts[:username].blank? && opts[:username]) || 'username'
+        o[:password]   = (!opts[:password].blank? && opts[:password]) || 'P@$$w0rd'
+        o[:email]      = (!opts[:email].blank? && opts[:email]) || 'test@example.com'
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  c.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  c.include Stormpath::TestApiKeyHelpers
+  c.include Stormpath::TestResourceHelpers
+
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  c.before(:all) do
+    unless test_missing_env_vars.empty?
+      set_up_message = "In order to run the specs of the Stormpath SDK you need to setup the following environment variables:\n\t"
+      set_up_message << test_missing_env_vars.map do |var, message|
+        "#{var.to_s} : #{message}"
+      end.join("\n\t")
+      set_up_message << "\nBe sure to configure these before running the specs again."
+      raise set_up_message
+    end
+
+    destroy_all_stormpath_test_resources unless HIJACK_HTTP_REQUESTS_WITH_VCR
+  end
+
+  c.after(:all) do
+    destroy_all_stormpath_test_resources unless HIJACK_HTTP_REQUESTS_WITH_VCR
+  end
+end