tinypass 0.0.1

data/spec/unit/token/access_token_store_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper.rb'
+
+describe Tinypass::AccessTokenStore do
+  let(:store) { Tinypass::AccessTokenStore.new }
+  let(:token) { Tinypass::AccessToken.new('RID1', 0) }
+
+  describe "#load_tokens_from_cookie" do
+    let(:cookies) { build_tinypass_cookie(token) }
+
+    before do
+      store.load_tokens_from_cookie(cookies)
+    end
+
+    it "produces tokens with the correct length" do
+      expect(store.tokens.length).to eq 1
+    end
+
+    it "sets the raw cookie" do
+      expect(store.raw_cookie).to eq cookies.values.first
+    end
+
+    it "sets the RID correctly" do
+      expect(store.get_access_token('RID1')).not_to be_nil # also tests #get_access_token
+    end
+
+    it "sets the other values correctly" do
+      expect(store.get_access_token('RID1').token_data.values).to eq token.token_data.values # also tests #get_access_token
+    end
+  end
+
+  describe "#get_access_token" do
+    it "returns an RID_NOT_FOUND token if absent and there are tokens" do
+      Tinypass::AccessToken.new('not in store', 0)
+      store.tokens << token
+      found_token = store.get_access_token('not in store')
+
+      expect(found_token).not_to be_nil
+      expect(found_token.access_granted?).to be_false
+      expect(found_token.metered?).to be_false
+      expect(found_token.meter_type).to eq 0
+      expect(found_token.trial_period_active?).to be_false
+      expect(found_token.lockout_period_active?).to be_false
+      expect(found_token.access_state).to eq Tinypass::AccessState::RID_NOT_FOUND
+    end
+
+    it "returns an RID_NOT_FOUND token if absent and empty" do
+      Tinypass::AccessToken.new('not in store', 0)
+      found_token = store.get_access_token('not_in_store')
+
+      expect(found_token).not_to be_nil
+      expect(found_token.access_granted?).to eq false
+      expect(found_token.access_state).to eq Tinypass::AccessState::NO_TOKENS_FOUND
+    end
+  end
+
+  describe "#has_token?" do
+    it "returns false when empty" do
+      expect(store.has_token?('absent')).to be_false
+    end
+
+    it "returns true when present" do
+      store.tokens << token
+      expect(store.has_token?(token.rid)).to be_true
+    end
+
+    it "returns false when absent but not empty" do
+      expect(store.has_token?('absent')).to be_false
+    end
+  end
+
+  describe "#find_active_token" do
+    it "returns nil when empty" do
+      expect(store.find_active_token(/absent/)).to be_nil
+    end
+
+    it "returns nil when token is inactive" do
+      expired_token = Tinypass::AccessToken.new('expired', Time.now.to_i - 1)
+      store.tokens << expired_token
+
+      expect(store.find_active_token(/expired/)).to be_nil
+    end
+
+    it "returns the token when found" do
+      store.tokens << token
+      expect(store.find_active_token(Regexp.new(token.rid))).to eq token
+    end
+
+    it "returns the token when not found" do
+      store.tokens << token
+      expect(store.find_active_token(/absent/)).to be_nil
+    end
+  end
+end

data/spec/unit/token/meter_helper_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Tinypass::MeterHelper do
+  describe ".create_view_based" do
+    it "delegates to Meter" do
+      Tinypass::Meter.should_receive(:create_view_based).with('meter name', 20, '24 hours').
+        and_return('what meter generated')
+      expect(Tinypass::MeterHelper.create_view_based('meter name', 20, '24 hours')).to eq 'what meter generated'
+    end
+  end
+
+  describe ".create_time_based" do
+    it "delegates to Meter" do
+      Tinypass::Meter.should_receive(:create_time_based).with('meter name', '24 hours', '72 hours').
+        and_return('what meter generated')
+      expect(Tinypass::MeterHelper.create_time_based('meter name', '24 hours', '72 hours')).to eq 'what meter generated'
+    end
+  end
+
+  describe ".load_meter_from_cookie" do
+    it "returns nil when trial is done" do
+      token = build_expired_trial_access_token('RID')
+      cookie = build_tinypass_cookie(token, 'RID')
+
+      expect(Tinypass::MeterHelper.load_meter_from_cookie('RID', cookie)).to be_nil
+    end
+
+    it "returns nil when rid not found" do
+      token = Tinypass::AccessToken.new('RID')
+      cookie = build_tinypass_cookie(token, 'RID')
+
+      expect(Tinypass::MeterHelper.load_meter_from_cookie('unknown rid', cookie)).to be_nil
+    end
+
+    it "returns the meter when found and active" do
+      token = build_active_trial_access_token('RID')
+      cookie = build_tinypass_cookie(token, 'RID')
+      meter = Tinypass::MeterHelper.load_meter_from_cookie('RID', cookie)
+
+      expect(meter).not_to be_nil
+      expect(meter.data.values).to eq token.token_data.values
+    end
+  end
+
+  describe ".load_meter_from_serialized_data" do
+    it "returns nil when trial is done" do
+      token = build_expired_trial_access_token('RID')
+      meter = Tinypass::Meter.new(token)
+      serialized = Tinypass::MeterHelper.serialize(meter)
+
+      expect(Tinypass::MeterHelper.load_meter_from_serialized_data(serialized)).to be_nil
+    end
+
+    it "returns the meter when found and active" do
+      token = build_active_trial_access_token('RID')
+      meter = Tinypass::Meter.new(token)
+      serialized = Tinypass::MeterHelper.serialize(meter)
+      deserialized = Tinypass::MeterHelper.load_meter_from_serialized_data(serialized)
+
+      expect(deserialized).not_to be_nil
+      expect(deserialized.data.values).to eq meter.data.values
+    end
+  end
+
+  describe "#serialize + #deserialize" do
+    it "is symmetrical" do
+      meter = Tinypass::MeterHelper.create_view_based('rid', 1, '1 second')
+      serialized = Tinypass::MeterHelper.serialize(meter)
+      deserialized = Tinypass::MeterHelper.deserialize(serialized)
+      expect(meter.data.values).to eq deserialized.data.values
+    end
+  end
+
+  describe "#serialize_to_json + #deserialize" do
+    it "is symmetrical" do
+      meter = Tinypass::MeterHelper.create_view_based('rid', 1, '1 second')
+      serialized = Tinypass::MeterHelper.serialize_to_json(meter)
+      json_string = serialized[5..-1] # skip encoding header
+      MultiJson.load(json_string) # if not json, this explodes
+      deserialized = Tinypass::MeterHelper.deserialize(serialized)
+      expect(meter.data.values).to eq deserialized.data.values
+    end
+  end
+
+  describe "#generate_cookie_embed_script" do
+    it "produces the expected script tag when not locked out" do
+      Time.should_receive('now').at_least(:once).and_return(Time.new(2013, 9, 24, 12, 12, 23))
+      meter = Tinypass::MeterHelper.create_time_based('name', '1 week', '1 day')
+      script_tag = Tinypass::MeterHelper.generate_cookie_embed_script('cookie_name', meter)
+
+      expect(script_tag).to eq "<script>\n        document.cookie='cookie_name=%7Bjax%7DFKb1__OSKlSF7CJ55VTdCksOd3POWF5-bLQ3tDcl6MhKE0YsLW3Mh0t3PabcEnAOOr_RmnEIYP_bgv6ghLMUCoquOlmyWv3IDqvgiJ6UBo0~~~FWrTYDq0ljU3Bsn3Brqz6peZODWs9lZmeRbTkU6o7o8; path=/; expires=2013-12-23 16:12:23 UTC;';\n      </script>"
+    end
+
+    it "produces the expected script tag when locked out" do
+      Time.should_receive('now').at_least(:once).and_return(Time.new(2013, 9, 24, 12, 12, 23))
+      meter = Tinypass::MeterHelper.create_view_based('meter_name', 20, '1 day')
+      21.times { meter.increment } # NOTE: probable off-by-one error
+      script_tag = Tinypass::MeterHelper.generate_cookie_embed_script('cookie_name', meter)
+
+      expect(script_tag).to eq "<script>\n        document.cookie='cookie_name=%7Bjax%7DyRg67-kFA8Cn0OD9JZhGfYoWyixspCG9n-trTyhzROo1zmFLI4YDk9KIKl4lnGeLBITKfHXaxRhnF7BaKgwuz6vsLbAxfLR3aXahAA9XaiaCGLR-GiCAOlyHHlb5bOUxlbvR1xuqpJqQFSXE5EXQ0A~~~aoKI1vpw7ISE9xV_lR_R0gC54x__3vFrcEiZkLLffcw; path=/; expires=2013-09-25 16:13:23 UTC;';\n      </script>"
+    end
+  end
+end

data/spec/unit/token/meter_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Tinypass::Meter do
+  describe "#increment" do
+    it "increments the view count" do
+      meter = Tinypass::Meter.create_view_based('rid', 100, '1 day')
+      meter.increment
+      expect(meter.trial_view_count).to eq 1
+    end
+  end
+
+  describe "#data" do
+    it "returns the TokenData" do
+      meter = Tinypass::Meter.create_time_based('rid', '1 week', '24 hours')
+      data = meter.data
+
+      expect(data.rid).to eq 'rid'
+      expect(data[Tinypass::TokenData::METER_TRIAL_ENDTIME]).to eq Time.now.to_i + 60 * 60 * 24 * 7
+      expect(data[Tinypass::TokenData::METER_LOCKOUT_ENDTIME]).to eq Time.now.to_i + 60 * 60 * 24 * 8
+    end
+  end
+
+  describe ".create_view_based" do
+    let(:max_views) { 123 }
+    let(:trial_period) { '1 day' }
+    let(:meter) { Tinypass::Meter.create_view_based('rid', max_views, trial_period) }
+
+    it "returns a meter" do
+      expect(meter).to be_kind_of Tinypass::Meter
+    end
+
+    it "sets the fields" do
+      expect(meter.view_based?).to be_true
+      expect(meter.meter_type).to eq Tinypass::TokenData::METER_REMINDER
+      expect(meter.trial_view_count).to eq 0
+      expect(meter.trial_view_limit).to eq max_views
+      expect(meter.trial_end_time_secs).to eq Time.now.to_i + 60 * 60 * 24
+      expect(meter.lockout_end_time_secs).to eq Time.now.to_i + 60 * 60 * 24
+
+      expect(meter.trial_dead?).to be_false
+      expect(meter.trial_period_active?).to be_true
+      expect(meter.lockout_period_active?).to be_false
+    end
+  end
+
+  describe ".create_time_based" do
+    let(:trial_period) { '1 day' }
+    let(:lockout_period) { '1 day' }
+    let(:meter) { Tinypass::Meter.create_time_based('rid', trial_period, lockout_period) }
+
+    it "returns a meter" do
+      expect(meter).to be_kind_of Tinypass::Meter
+    end
+
+    it "sets the fields" do
+      expect(meter.view_based?).to be_false
+      expect(meter.meter_type).to eq Tinypass::TokenData::METER_REMINDER
+      expect(meter.trial_end_time_secs).to eq Time.now.to_i + 60 * 60 * 24
+      expect(meter.lockout_end_time_secs).to eq Time.now.to_i + 60 * 60 * 24 * 2
+
+      expect(meter.trial_dead?).to be_false
+      expect(meter.trial_period_active?).to be_true
+      expect(meter.lockout_period_active?).to be_false
+    end
+  end
+end

data/spec/unit/token/token_data_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper.rb'
+
+describe Tinypass::TokenData do
+  let(:token_data) { Tinypass::TokenData.new }
+
+  it "supports hash writes and reads" do
+    token_data[:key] = 'value'
+    expect(token_data['key']).to eq 'value'
+    expect(token_data[:key]).to eq 'value'
+  end
+
+  describe "#rid returns the rid" do
+    it "returns the rid field" do
+      token_data[Tinypass::TokenData::RID] = 'the rid'
+      expect(token_data[Tinypass::TokenData::RID]).to eq 'the rid'
+    end
+  end
+
+  describe "#values" do
+    it "returns the internal hash" do
+      token_data[:key] = 'value'
+      expect(token_data.values).to eq('key' => 'value')
+    end
+  end
+
+  describe "#fetch" do
+    it "returns the value when present" do
+      token_data[:key] = 'value'
+      expect(token_data.fetch(:key)).to eq 'value'
+    end
+
+    it "returns the default when not" do
+      expect(token_data.fetch(:key, 'default value')).to eq 'default value'
+    end
+  end
+
+  describe "#size" do
+    it "returns 0 when new" do
+      expect(token_data.size).to eq 0
+    end
+
+    it "returns the size when populated" do
+      token_data[:key] = 'value'
+      token_data['other_key'] = 123
+      expect(token_data.size).to eq 2
+    end
+  end
+
+  describe "#merge" do
+    it "sets more than one value at once" do
+      token_data.merge(key_1: 1, key_2: 2)
+      token_data.merge(key_3: 'abc', key_4: 'def')
+      expect(token_data.values).to eq('key_1' => 1, 'key_2' => 2, 'key_3' => 'abc', 'key_4' => 'def')
+    end
+  end
+
+  describe ".convert_to_epoch_seconds" do
+    it "returns the input if before the year ~43k AD" do
+      expect(Tinypass::TokenData.convert_to_epoch_seconds(1000)).to eq 1000
+    end
+
+    it "converts from milliseconds if beyond the year ~43k AD" do
+      expect(Tinypass::TokenData.convert_to_epoch_seconds(1293858000000 + 1)).to eq 1293858000
+    end
+  end
+end

data/spec/unit/ui/html_widget_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Tinypass::HtmlWidget do
+  let(:resource) { Tinypass::Resource.new('RID1', 0) }
+  let(:price_option) { Tinypass::PriceOption.new('.50', '24 hours') }
+  let(:other_price_option) { Tinypass::PriceOption.new('.50', '1 week') }
+  let(:offer) { Tinypass::Offer.new(resource, price_option, other_price_option) }
+
+  let(:purchase_request) do
+    request = Tinypass::PurchaseRequest.new(offer)
+    request.callback = 'myFunction'
+    request
+  end
+
+  let(:widget) { Tinypass::HtmlWidget.new }
+
+  describe "#create_button_html" do
+    let(:html) { widget.create_button_html(purchase_request) }
+    let(:doc) { Nokogiri::XML(html) }
+    let(:node) { doc.children.first }
+
+    it "is stringy" do
+      expect(html).to respond_to :to_str
+    end
+
+    it "produces no unexpected parsing errors" do
+      expect(doc.errors.length).to eq 1
+      expect(doc.errors.first.message).to eq "Namespace prefix tp on request is not defined" # TODO: fragile
+    end
+
+    it "sets the tag name as expected" do
+      expect(node.name).to eq 'tp:request'
+    end
+
+    it "sets the type attribute" do
+      expect(node[:type]).to eq 'purchase'
+    end
+
+    it "sets the rid attribute" do
+      expect(node[:rid]).to eq 'RID1'
+    end
+
+    it "sets the url attribute" do
+      expect(node[:url]).to eq 'https://sandbox.tinypass.com/v2'
+    end
+
+    it "sets the aid attribute" do
+      expect(node[:aid]).to eq 'TEST_AID'
+    end
+
+    it "sets the cn attribute" do
+      expect(node[:cn]).to eq '__TP_TEST_AID_TOKEN'
+    end
+
+    it "sets the v attribute" do
+      expect(node[:v]).to eq '2.0.7'
+    end
+
+    it "starts the rdata correctly" do
+      expect(node[:rdata]).to start_with '{jax}'
+    end
+
+    it "has an rdata hmac delimiter" do
+      expect(node[:rdata]).to include '~~~'
+    end
+
+    it "sets the callback" do
+      expect(node[:oncheckaccess]).to eq 'myFunction'
+    end
+
+    context "options" do
+      context "button.html" do
+        let(:purchase_request) { Tinypass::PurchaseRequest.new(offer, "button.html" => 'custom html "goes" here') }
+
+        it "sets and html_encodes the value" do
+          expect(node[:custom]).to eq 'custom html "goes" here'
+        end
+      end
+
+      context "button.html" do
+        let(:purchase_request) { Tinypass::PurchaseRequest.new(offer, "button.link" => 'custom link "goes" here') }
+
+        it "sets and html_encodes the value" do
+          expect(node[:link]).to eq 'custom link "goes" here'
+        end
+      end
+    end
+  end
+end

data/spec/unit/ui/purchase_request_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper.rb'
+
+describe Tinypass::PurchaseRequest do
+  let(:resource) { Tinypass::Resource.new('RID1', 0) }
+  let(:price_option) { Tinypass::PriceOption.new('.50', '24 hours') }
+  let(:other_price_option) { Tinypass::PriceOption.new('.50', '1 week') }
+  let(:offer) { Tinypass::Offer.new(resource, price_option, other_price_option) }
+
+  let(:purchase_request) { Tinypass::PurchaseRequest.new(offer) }
+
+  describe "#generate_tag" do
+    it "delegates to an HtmlWidget" do
+      Tinypass::HtmlWidget.any_instance.should_receive(:create_button_html).with(purchase_request).and_return("generated html")
+      html = purchase_request.generate_tag
+      expect(html).to eq 'generated html'
+    end
+  end
+
+  describe "#generate_link" do
+    it "returns the expected value" do
+      Tinypass::ClientBuilder.any_instance.should_receive(:build_purchase_request).with(purchase_request).and_return("purchase_request_string")
+      link = purchase_request.generate_link('return_url', 'cancel_url')
+      expect(link).to eq "https://sandbox.tinypass.com/v2/jsapi/auth.js?aid=#{ Tinypass.aid }&r=purchase_request_string"
+    end
+  end
+
+  it "can set the user ref" do
+    purchase_request.user_ref = 'user'
+    expect(purchase_request.user_ref).to eq 'user'
+  end
+
+  it "can set client_ip" do
+    purchase_request.client_ip = '127.0.0.1'
+    expect(purchase_request.client_ip).to eq '127.0.0.1'
+  end
+
+  it "sets the offer" do
+    expect(purchase_request.primary_offer).to eq offer
+  end
+
+  it "can set the secondary offer" do
+    other_offer = Tinypass::Offer.new(Tinypass::Resource.new('RID2', 0), Tinypass::PriceOption.new('10', '1 year'))
+    purchase_request.secondary_offer = other_offer
+    expect(purchase_request.secondary_offer).to eq other_offer
+  end
+end