oi-api-ruby 0.1.1

data/spec/oi_api/client/subscriptions_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+require 'shared_examples_for_get_resource.rb'
+require 'shared_examples_for_get_resources.rb'
+require 'shared_examples_for_post_resource.rb'
+
+RSpec.describe OiApi::Client::Subscriptions do
+
+  let(:api) { Factory.api_client }
+
+end

data/spec/oi_api_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe OiApi do
+
+  it 'has a version' do
+    expect(OiApi::VERSION).to be_instance_of(String)
+  end
+
+  context 'configuration' do
+
+    context '.username' do
+      it 'defaults nil' do
+        expect(OiApi.username).to be_nil
+      end
+    end
+
+    context '.password' do
+      it 'defaults nil' do
+        expect(OiApi.password).to be_nil
+      end
+    end
+
+    context '.api_endpoint' do
+      it 'has a default' do
+        expect(OiApi.api_endpoint).to eql(OiApi::Configuration::DEFAULT_API_ENDPOINT)
+      end
+    end
+
+    context '.user_agent' do
+      it 'has a default' do
+        expect(OiApi.user_agent).to eql(OiApi::Configuration::DEFAULT_USER_AGENT)
+      end
+    end
+
+    context '.format' do
+      it 'has a default' do
+        expect(OiApi.format).to eql(OiApi::Configuration::DEFAULT_FORMAT)
+      end
+    end
+
+    context '.content_type' do
+      it 'has a default' do
+        expect(OiApi.content_type).to eql(OiApi::Configuration::DEFAULT_CONTENT_TYPE)
+      end
+    end
+
+  end
+
+end

data/spec/shared_examples_for_delete_resource.rb

@@ -0,0 +1,37 @@
+RSpec.shared_examples 'DELETE resource' do |resource_name, options|
+
+  it 'returns the correct message' do
+    expect(response['message']).to eql("#{titleized_resource(resource_name)} Succesfully deleted")
+  end
+
+  it 'returns the correct status' do
+    expect(response['status']).to eql('Delete Successful')
+  end
+
+  it 'returns 200 OK' do
+    expect(response.code).to eql 200
+  end
+
+  it 'deletes a data transfer' do
+    response
+    resource_id = eval("#{resource_name}['id']")
+    expect(api.public_send(resource_name, resource_id).code).to eql 404
+  end
+
+  context "when #{resource_name} not found" do
+
+    it 'returns not found error message' do
+      expect(not_found_response['message']).to eql 'Record not found'
+    end
+
+    it 'returns not found error status' do
+      expect(not_found_response['status']).to eql 'Request Failed'
+    end
+
+    it 'returns 404' do
+      expect(not_found_response.code).to eql 404
+    end
+
+  end
+
+end

data/spec/shared_examples_for_get_resource.rb

@@ -0,0 +1,33 @@
+RSpec.shared_examples 'GET resource' do |resource_name, options|
+
+  it 'returns 200 OK' do
+    expect(response.code).to eql 200
+  end
+
+  it 'returns HTTParty::Response' do
+    expect(response.class).to eql HTTParty::Response
+  end
+
+  it 'returns the resource' do
+    keys = Factory.public_send("valid_#{resource_name}_params".to_sym).keys.map(&:to_s)
+    expect(response.keys).to include *keys
+  end
+
+  context "when #{resource_name}_id not found" do
+
+    it 'returns not found error message' do
+      expect(not_found_response['message']).to eql 'Record not found'
+    end
+
+    it 'returns not found error message' do
+      expect(not_found_response['status']).to eql 'Retrieve Failed'
+    end
+
+    it 'returns 404' do
+      expect(not_found_response.code).to eql 404
+    end
+
+  end
+
+end
+

data/spec/shared_examples_for_get_resources.rb

@@ -0,0 +1,15 @@
+RSpec.shared_examples 'GET resources' do |resource_name, options|
+
+  it 'returns 200 OK' do
+    expect(response.code).to eql 200
+  end
+
+  it 'returns HTTParty::Response' do
+    expect(response.class).to eql HTTParty::Response
+  end
+
+  it 'returns all resources' do
+    expect(response.size).to eql options[:expected_num_resources]
+  end
+
+end

data/spec/shared_examples_for_post_resource.rb

@@ -0,0 +1,31 @@
+RSpec.shared_examples 'POST resource' do |resource_name, options|
+
+  it 'returns a success message' do
+    expect(response['message']).to eql("#{titleized_resource(resource_name)} successfully created")
+  end
+
+  it 'returns a success status' do
+    expect(response['status']).to eql('Request Successful')
+  end
+
+  it 'returns 201 created' do
+    expect(response.code).to eql 201
+  end
+
+  context 'bad request' do
+
+    it 'returns 400 bad request with invalid params' do
+      expect(bad_response.code).to eql 400
+    end
+
+    it 'returns an error message' do
+      expect(bad_response['message']).to eql(bad_response_message)
+    end
+
+    it 'returns an error status' do
+      expect(bad_response['status']).to eql(bad_response_status)
+    end
+
+  end
+
+end

data/spec/shared_examples_for_put_resource.rb

@@ -0,0 +1,46 @@
+RSpec.shared_examples 'PUT resource' do |resource_name, options|
+
+  it "returns the correct status" do
+    expect(response['status']).to eql('Request Successful')
+  end
+
+  it "returns the correct message" do
+    expect(response['message']).to eql("#{titleized_resource(resource_name)} successfully updated")
+  end
+
+  it 'returns 200 OK' do
+    expect(response.code).to eql 200
+  end
+
+  context 'bad request' do
+
+    it 'returns 400 bad request with invalid params' do
+      expect(bad_response.code).to eql 400
+    end
+
+    it 'returns an error message' do
+      expect(bad_response['message']).to eql(bad_response_message)
+    end
+
+    it 'returns an error status' do
+      expect(bad_response['status']).to eql(bad_response_status)
+    end
+  end
+
+  context "when #{resource_name} not found" do
+
+    it 'returns 404' do
+      expect(not_found_response.code).to eql 404
+    end
+
+    it 'returns not found error message' do
+      expect(not_found_response['message']).to eql "#{titleized_resource(resource_name)} not found"
+    end
+
+    it 'returns error status' do
+      expect(not_found_response['status']).to eql 'Update Failed'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib', 'oi_api')
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'support')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'dotenv'
+Dotenv.load
+
+require 'oi_api'
+require 'rspec'
+require 'vcr'
+require 'pry'
+require 'support/factory'
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.hook_into :webmock
+  c.cassette_library_dir = 'spec/cassettes'
+  c.configure_rspec_metadata!
+
+  c.filter_sensitive_data('<USERNAME>') do |interaction|
+    CGI.escape(Factory.test_oi_username)
+  end
+
+  c.filter_sensitive_data('<PASSWORD>') do |interaction|
+    CGI.escape(Factory.test_oi_password)
+  end
+end
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = false
+
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+  Kernel.srand config.seed
+end
+
+def titleized_resource(resource_name)
+  resource_name.to_s.split('_').map(&:capitalize).join
+end

data/spec/support/advertisers_factory.rb

@@ -0,0 +1,22 @@
+module AdvertisersFactory
+
+  def valid_advertiser_params(params = {})
+    {
+      'name': "new advertiser #{random_string}",
+      'status_id': 1,
+      'category_id': 1010
+    }.merge(params)
+  end
+
+  def create_advertiser(params = {})
+    _params = valid_advertiser_params.merge(params)
+    api_client.create_advertiser(_params)
+  end
+
+  def delete_all_advertisers
+    api_client.advertisers.each do |advertiser|
+      api_client.delete_advertiser(advertiser['id'])
+    end
+  end
+
+end

data/spec/support/auto_responders_factory.rb

@@ -0,0 +1,27 @@
+module AutoRespondersFactory
+
+  def valid_auto_responder_params(params = {})
+    {
+      status_id:  1,
+      subject: 'Here\'s a good subject line',
+      from_name: 'Our Company',
+      body_html: 'some html here',
+      body_text: 'some text here'
+    }.merge(params)
+  end
+
+  def create_auto_responder(params = {})
+    offer_id = if params.has_key?(:offer_id)
+      params.delete(:offer_id)
+    else
+      create_offer['id']
+    end
+
+    _params = valid_auto_responder_params(params)
+    api_client.create_auto_responder(offer_id, _params)
+  end
+
+  def delete_all_auto_responders
+  end
+
+end

data/spec/support/balances_factory.rb

@@ -0,0 +1,12 @@
+module BalancesFactory
+
+  def valid_balance_params(params = {})
+  end
+
+  def create_balance(params = {})
+  end
+
+  def delete_all_balances
+  end
+
+end

data/spec/support/cards_factory.rb

@@ -0,0 +1,34 @@
+module CardsFactory
+
+  def valid_card_params(params = {})
+    {
+      number: 0000111122223333,
+      exp_month: 12,
+      exp_year: 16,
+      cvc: 111,
+      name: 'John Tester',
+      address_line1: '123 Elm Street',
+      address_line2: 'Apt 2',
+      address_city: 'Rochester',
+      address_zip: 14605,
+      address_state: 'NY',
+      address_country: 'US',
+      default: 'true'
+    }.merge(params)
+  end
+
+  def create_card(params = {})
+    advertiser_id = if params.has_key?(:advertiser_id)
+      params.delete(:advertiser_id)
+    else
+      create_advertiser['id']
+    end
+
+    _params = valid_card_params(params)
+    api_client.create_card(advertiser_id, _params)
+  end
+
+  def delete_all_cards
+  end
+
+end

data/spec/support/charges_factory.rb

@@ -0,0 +1,16 @@
+module ChargesFactory
+
+  def valid_charge_params(params = {})
+    {
+      card_id: 123934354353432,
+      amount: 100
+    }
+  end
+
+  def create_charge(params = {})
+  end
+
+  def delete_all_charges
+  end
+
+end

data/spec/support/data_transfers_factory.rb

@@ -0,0 +1,34 @@
+module DataTransfersFactory
+
+  def valid_data_transfer_params(params ={})
+    offer_id = if params.has_key?(:offer_id)
+      params.delete(:offer_id)
+    else
+      create_offer['id']
+    end
+
+    {
+      name: "DT for Special Product 1 #{random_string}",
+      status_id: 1,
+      type: 'http',
+      offer_id: offer_id,
+      dt_info: {
+        base_url: 'http://www.someclientbaseurl.com',
+        method: 'POST'
+      },
+      data_fields: [
+        { email: '#{EM}' },
+        { first_name: '#{FN}' },
+        { last_name: '#{LN}' },
+        { zip: '#{PO}' },
+        { gender: '#{G}' }
+      ]
+    }
+  end
+
+  def create_data_transfer(params = {})
+    _params = valid_data_transfer_params(params)
+    api_client.create_data_transfer(_params[:offer_id], _params)
+  end
+
+end