soapy_cake 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ded8535f4f057f3e55884f2c0cc218743e4134b9
-  data.tar.gz: 34dda1abcf277214c5d9442e35da548fc3667b36
+  metadata.gz: 27d71b226fedab0e2e0d7da24e6ade998e9468c1
+  data.tar.gz: ef9dbece2ee345c0c89dcbb8fa2a49cdcd46092b
 SHA512:
-  metadata.gz: a0ffe0fa81c8b12a34b56cc3a680825ccf2dbee32106b76ee7bdb812d154b6b1cb99cbbdcdce4a88dfbbf72d8ebeaf2f9a852e30dc099cbb378a072499bb343f
-  data.tar.gz: e27a015d263b827d239142cd315a294846c2b8aacd90b5a7edf6e8c0d56e5333b73968c7d47e8bb43fd1ec81e858b993496571a4fd8098e6fc677b0af171e469
+  metadata.gz: 49718d7793da7f77650c1df7bb034e76334d3b86c60450fb435f8309d480b9fba2d2be98cfc8e20e20c0912978482a8b41b530789d83f9b3ae732e03a9f52c29
+  data.tar.gz: 80f82b060367a774ee40971ab9d10ec7d40135a05cabd6fc4cccc57a08735ee88b49bb1a6b5eb758e1a458a9b2b991f27b45ea5a7a17c791d031ecdff4b476fd

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage Examples
 
-First we assume that you set the `CAKE_DOMAIN`, `CAKE_API_KEY` and `CAKE_TIME_OFFSET`
+First we assume that you set the `CAKE_DOMAIN`, `CAKE_API_KEY` and `CAKE_TIME_ZONE`
 environment variables.
 
 Export all advertisers:
@@ -44,6 +44,12 @@ SoapyCake::Admin.new.affiliate_summary(
 If you are interested in how we map methods to api endpoints take a look
 at [api_versions.yml](api_versions.yml).
 
+## Time/Date Handling
+- Define `CAKE_TIME_ZONE`
+- Specify dates with any timezone in requests (will be converted to the correct CAKE timezone)
+- `Date` objects in requests will be treated as UTC (just like `.to_datetime` would do)
+- Responses contain UTC dates which can be converted however you like
+
 ## Contributing
 
 1. Fork it (https://github.com/ad2games/soapy_cake/fork)

data/lib/soapy_cake.rb

@@ -2,15 +2,14 @@ require 'nokogiri'
 require 'saxerator'
 require 'httparty'
 require 'active_support/core_ext/hash/reverse_merge'
-require 'active_support/core_ext/date'
-require 'active_support/core_ext/numeric/time'
-require 'active_support/core_ext/time/zones'
 require 'active_support/core_ext/hash/transform_values'
+require 'active_support/time'
 
 require 'soapy_cake/version'
 require 'soapy_cake/const'
 require 'soapy_cake/helper'
 require 'soapy_cake/error'
+require 'soapy_cake/time_converter'
 require 'soapy_cake/request'
 require 'soapy_cake/response'
 require 'soapy_cake/response_value'

data/lib/soapy_cake/client.rb

@@ -1,12 +1,15 @@
 module SoapyCake
   class Client
-    attr_reader :domain, :api_key, :time_offset
+    attr_reader :domain, :api_key, :time_converter
 
     def initialize(opts = {})
       @domain = opts.fetch(:domain, ENV['CAKE_DOMAIN']) || fail(Error, 'Cake domain missing')
       @api_key = opts.fetch(:api_key, ENV['CAKE_API_KEY']) || fail(Error, 'Cake API key missing')
-      @time_offset = opts.fetch(:time_offset, ENV['CAKE_TIME_OFFSET']) ||
-        fail(Error, 'Cake time offset missing')
+
+      time_offset = opts.fetch(:time_offset, ENV['CAKE_TIME_OFFSET'])
+      time_zone = opts.fetch(:time_zone, ENV['CAKE_TIME_ZONE'])
+      @time_converter = TimeConverter.new(time_zone, time_offset)
+
       @opts = opts
     end
 
@@ -20,11 +23,10 @@ module SoapyCake
 
     def run(request)
       request.api_key = api_key
-      request.time_offset = time_offset
+      request.time_converter = time_converter
 
-      Response
-        .new(response_body(request), request.short_response?, time_offset)
-        .public_send(:"to_#{xml_response? ? 'xml' : 'enum'}")
+      response = Response.new(response_body(request), request.short_response?, time_converter)
+      xml_response? ? response.to_xml : response.to_enum
     end
 
     private

data/lib/soapy_cake/request.rb

@@ -1,6 +1,8 @@
 module SoapyCake
   class Request
-    attr_accessor :api_key, :time_offset
+    DATE_CLASSES = [Date, Time, DateTime].freeze
+
+    attr_accessor :api_key, :time_converter
     attr_reader :role, :service, :method, :opts
 
     def initialize(role, service, method, opts = {})
@@ -40,7 +42,7 @@ module SoapyCake
     def xml_params(xml)
       xml.api_key api_key
       opts.each do |k, v|
-        xml.public_send(k.to_sym, format_param(v))
+        xml.public_send(k.to_sym, format_param(k, v))
       end
     end
 
@@ -51,13 +53,14 @@ module SoapyCake
       }
     end
 
-    def format_param(value)
-      case value
-      when Time, DateTime, Date
-        (value.to_datetime.utc + time_offset.to_i.hours).strftime('%Y-%m-%dT%H:%M:%S')
-      else
-        value
+    def format_param(key, value)
+      return time_converter.to_cake(value) if DATE_CLASSES.include?(value.class)
+
+      if key.to_s.end_with?('_date')
+        fail Error, "You need to use a Time/DateTime/Date object for '#{key}'"
       end
+
+      value
     end
 
     def version

data/lib/soapy_cake/response.rb

@@ -5,12 +5,12 @@ module SoapyCake
     SHORT_ELEMENT_DEPTH = 3
     ELEMENTS_DEPTH = 5
 
-    attr_reader :body, :short_response, :time_offset
+    attr_reader :body, :short_response, :time_converter
 
-    def initialize(body, short_response, time_offset)
+    def initialize(body, short_response, time_converter)
       @body = body
       @short_response = short_response
-      @time_offset = time_offset
+      @time_converter = time_converter
     end
 
     def to_enum
@@ -37,7 +37,7 @@ module SoapyCake
 
     def typed_element(element)
       walk_tree(element) do |value, key|
-        ResponseValue.new(key, value, time_offset: time_offset).parse
+        ResponseValue.new(key, value, time_converter).parse
       end
     end
 

data/lib/soapy_cake/response_value.rb

@@ -6,17 +6,17 @@ module SoapyCake
     # Known string ids that should not be parsed as integers
     STRING_IDS = %w(tax_id transaction_id).freeze
 
-    def initialize(key, value, opts = {})
+    def initialize(key, value, time_converter)
       @key = key.to_s
       @value = value
-      @opts = opts
+      @time_converter = time_converter
     end
 
     def parse
       return parse_int if id? && !string_id?
       return false if false?
       return true if true?
-      return parse_date if date?
+      return time_converter.from_cake(value) if date?
 
       # cast to primitive string to get rid of Saxerator string class
       value.to_s
@@ -24,6 +24,8 @@ module SoapyCake
 
     private
 
+    attr_reader :time_converter
+
     def false?
       value == 'false'
     end
@@ -54,9 +56,5 @@ module SoapyCake
       end
       value.to_i
     end
-
-    def parse_date
-      DateTime.parse(value + format('%+03d:00', @opts[:time_offset].to_i))
-    end
   end
 end

data/lib/soapy_cake/time_converter.rb

@@ -0,0 +1,35 @@
+module SoapyCake
+  class TimeConverter
+    def initialize(time_zone, time_offset = nil)
+      if time_offset
+        self.class.print_deprecation_warning
+
+        # Etc/GMT time zones have their sign reversed
+        time_zone = format('Etc/GMT%+d', -time_offset.to_i)
+      end
+
+      fail Error, 'Cake time zone missing' if time_zone.blank?
+      @zone = ActiveSupport::TimeZone[time_zone]
+    end
+
+    def to_cake(date)
+      date = date.to_datetime if date.is_a?(Date)
+      date.in_time_zone(zone).strftime('%Y-%m-%dT%H:%M:%S')
+    end
+
+    def from_cake(value)
+      zone.parse(value).utc
+    end
+
+    private
+
+    attr_reader :zone
+
+    def self.print_deprecation_warning
+      return if @deprecation_warning_printed
+      @deprecation_warning_printed = true
+
+      STDERR.puts 'SoapyCake - DEPRECATED: Please use time_zone instead of time_offset.'
+    end
+  end
+end

data/lib/soapy_cake/version.rb

@@ -1,3 +1,3 @@
 module SoapyCake
-  VERSION = '1.15.0'.freeze
+  VERSION = '1.16.0'.freeze
 end

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/creates_an_affiliate_and_returns_the_ID.yml

@@ -26,7 +26,7 @@ http_interactions:
               <cake:contact_first_name>Foxy</cake:contact_first_name>
               <cake:contact_last_name>Fox</cake:contact_last_name>
               <cake:contact_email_address>foxy@forrest.com</cake:contact_email_address>
-              <cake:date_added>2015-06-15T01:00:00</cake:date_added>
+              <cake:date_added>2015-06-15T02:00:00</cake:date_added>
             </cake:Affiliate>
           </env:Body>
         </env:Envelope>

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/does_not_parse_a_transaction_id_as_an_integer.yml

@@ -12,8 +12,8 @@ http_interactions:
           <env:Body>
             <cake:Conversions>
               <cake:api_key>cake-api-key</cake:api_key>
-              <cake:start_date>2015-04-11T01:00:00</cake:start_date>
-              <cake:end_date>2015-04-12T01:00:00</cake:end_date>
+              <cake:start_date>2015-04-11T02:00:00</cake:start_date>
+              <cake:end_date>2015-04-12T02:00:00</cake:end_date>
               <cake:row_limit>1</cake:row_limit>
               <cake:conversion_type>conversions</cake:conversion_type>
             </cake:Conversions>

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_a_clicks_report_with_a_defined_time_range.yml

@@ -12,8 +12,8 @@ http_interactions:
           <env:Body>
             <cake:Clicks>
               <cake:api_key>cake-api-key</cake:api_key>
-              <cake:start_date>2014-06-30T01:00:00</cake:start_date>
-              <cake:end_date>2014-07-01T01:00:00</cake:end_date>
+              <cake:start_date>2014-06-30T02:00:00</cake:start_date>
+              <cake:end_date>2014-07-01T02:00:00</cake:end_date>
               <cake:row_limit>1</cake:row_limit>
             </cake:Clicks>
           </env:Body>

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminTrack/_mass_conversion_insert/inserts_conversions.yml

@@ -12,7 +12,7 @@ http_interactions:
           <env:Body>
             <cake:MassConversionInsert>
               <cake:api_key>cake-api-key</cake:api_key>
-              <cake:conversion_date>2015-05-06T01:00:00</cake:conversion_date>
+              <cake:conversion_date>2015-05-06T02:00:00</cake:conversion_date>
               <cake:affiliate_id>16059</cake:affiliate_id>
               <cake:campaign_id>13268</cake:campaign_id>
               <cake:sub_affiliate/>

data/spec/integration/soapy_cake/admin_spec.rb

@@ -12,12 +12,15 @@ RSpec.describe SoapyCake::Admin do
       hide_offers: false,
       # hashes and id-params
       billing_cycle: { billing_cycle_id: 1, billing_cycle_name: 'Weekly' },
-      # dates
-      date_created: DateTime.new(2014, 4, 28, 10, 52, 15.537),
       # floats
       minimum_payment_threshold: '0.0000'
     )
 
+    # dates
+    expect(result.first[:date_created]).to be_a(Time)
+    expect(result.first[:date_created].to_s)
+      .to eq(Time.utc(2014, 4, 28, 8, 52, 15.537).to_s)
+
     # strings should be actual Strings, not some Saxerator element class
     expect(result.first[:affiliate_name].class).to eq(String)
 

data/spec/lib/soapy_cake/request_spec.rb

@@ -4,4 +4,10 @@ RSpec.describe SoapyCake::Request do
       described_class.new(:test, :does, :not_exist).xml
     end.to raise_error(SoapyCake::Error, 'Unknown API call test::does::not_exist')
   end
+
+  it 'raises when you pass non-date-like objects in date fields' do
+    expect do
+      described_class.new(:admin, :export, :offers, start_date: '2015-01-01').xml
+    end.to raise_error(SoapyCake::Error, /Date object for 'start_date'/)
+  end
 end

data/spec/lib/soapy_cake/response_value_spec.rb

@@ -1,58 +1,55 @@
 RSpec.describe SoapyCake::ResponseValue do
-  def subject(*args)
-    described_class.new(*args)
+  let(:time_converter) { double('date converter') }
+
+  def parse(key, value)
+    described_class.new(key, value, time_converter).parse
   end
 
   describe '#parse' do
     context 'booleans' do
       it 'converts the string "true" to the true value' do
-        expect(subject(:foo, 'true').parse).to eq(true)
+        expect(parse(:foo, 'true')).to eq(true)
       end
 
       it 'converts the string "false" to the false value' do
-        expect(subject(:foo, 'false').parse).to eq(false)
+        expect(parse(:foo, 'false')).to eq(false)
       end
     end
 
     context 'dates' do
-      it 'parses an ISO-formatted date' do
-        expect(subject(:foo, '2014-06-30T01:00:00').parse).to eq(DateTime.new(2014, 6, 30, 1))
-      end
-
-      it 'properly applies the provided time offset' do
-        expect(subject(:foo, '2014-01-01T00:00:00', time_offset: 5).parse)
-          .to eq(DateTime.new(2014, 1, 1, 0).change(offset: '+0500'))
+      it 'delegates date-conversion to a TimeConverter instance' do
+        expect(time_converter).to receive(:from_cake)
+          .with('2014-06-30T01:00:00').and_return(:nice_date)
 
-        expect(subject(:foo, '2014-12-31T01:00:00', time_offset: -2).parse)
-          .to eq(DateTime.new(2014, 12, 31, 1).change(offset: '-0200'))
+        expect(parse(:foo, '2014-06-30T01:00:00')).to eq(:nice_date)
       end
     end
 
     context 'strings' do
       it 'parses a string' do
-        expect(subject(:foo, 'abc').parse).to eq('abc')
+        expect(parse(:foo, 'abc')).to eq('abc')
       end
     end
 
     context 'IDs' do
       it 'converts keys ending in "_id" to integers' do
-        expect(subject(:conversion_id, '42').parse).to eq(42)
+        expect(parse(:conversion_id, '42')).to eq(42)
       end
 
       it "doesn't convert ids in the blacklist to integers" do
-        expect(subject(:tax_id, '123abc').parse).to eq('123abc')
-        expect(subject(:other_tax_id, '123abc').parse).to eq('123abc')
-        expect(subject(:transaction_id, '123abc').parse).to eq('123abc')
+        expect(parse(:tax_id, '123abc')).to eq('123abc')
+        expect(parse(:other_tax_id, '123abc')).to eq('123abc')
+        expect(parse(:transaction_id, '123abc')).to eq('123abc')
       end
 
       it 'raises an error if not in the blacklist and non-digit characters are detected' do
-        expect { subject(:foo_id, '123abc').parse }.to raise_error(SoapyCake::Error)
+        expect { parse(:foo_id, '123abc') }.to raise_error(SoapyCake::Error)
       end
 
       it 'does not raise an error if the value is absent' do
-        expect(subject(:foo_id, '-1').parse).to eq(-1)
-        expect(subject(:foo_id, '').parse).to eq(0)
-        expect(subject(:foo_id, nil).parse).to eq(0)
+        expect(parse(:foo_id, '-1')).to eq(-1)
+        expect(parse(:foo_id, '')).to eq(0)
+        expect(parse(:foo_id, nil)).to eq(0)
       end
     end
   end

data/spec/lib/soapy_cake/time_converter_spec.rb

@@ -0,0 +1,37 @@
+RSpec.describe SoapyCake::TimeConverter do
+  subject { described_class.new('Europe/Berlin') }
+
+  describe '#to_cake' do
+    it 'converts a time-like object into a cake timestamp' do
+      expect(subject.to_cake(DateTime.new(2015, 1, 2, 12, 30))).to eq('2015-01-02T13:30:00')
+      expect(subject.to_cake(Time.utc(2015, 1, 2, 12, 30))).to eq('2015-01-02T13:30:00')
+      expect(subject.to_cake(Date.new(2015, 1, 2))).to eq('2015-01-02T01:00:00')
+    end
+
+    it 'respects DST' do
+      expect(subject.to_cake(Time.utc(2015, 1, 2, 12, 30))).to eq('2015-01-02T13:30:00')
+      expect(subject.to_cake(Time.utc(2015, 6, 2, 12, 30))).to eq('2015-06-02T14:30:00')
+    end
+  end
+
+  describe '#from_cake' do
+    it 'parses cake dates into the specified time zone (including DST)' do
+      expect(subject.from_cake('2015-01-11T14:53:40.000')).to be_a(Time)
+      expect(subject.from_cake('2015-01-11T14:53:40.000'))
+        .to eq(Time.utc(2015, 1, 11, 13, 53, 40))
+      expect(subject.from_cake('2015-06-11T14:53:40.000'))
+        .to eq(Time.utc(2015, 6, 11, 12, 53, 40))
+    end
+  end
+
+  context 'legacy mode / CAKE_TIME_OFFSET' do
+    subject { described_class.new('Europe/Berlin', 5) }
+
+    it 'works as before (broken, without DST)' do
+      expect(STDERR).to receive(:puts).with(/Please use time_zone/)
+
+      expect(subject.to_cake(DateTime.new(2015, 1, 2, 12, 30))).to eq('2015-01-02T17:30:00')
+      expect(subject.to_cake(DateTime.new(2015, 6, 2, 12, 30))).to eq('2015-06-02T17:30:00')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -41,7 +41,7 @@ end
 
 ENV['CAKE_API_KEY'] = 'cake-api-key' if ENV['CAKE_API_KEY'].blank?
 ENV['CAKE_DOMAIN'] = 'cake-partner-domain.com' if ENV['CAKE_DOMAIN'].blank?
-ENV['CAKE_TIME_OFFSET'] = '1' if ENV['CAKE_TIME_OFFSET'].blank?
+ENV['CAKE_TIME_ZONE'] = 'Europe/Berlin' if ENV['CAKE_TIME_ZONE'].blank?
 
 VCR.configure do |c|
   c.configure_rspec_metadata!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - ad2games GmbH
@@ -193,6 +193,7 @@ files:
 - lib/soapy_cake/request.rb
 - lib/soapy_cake/response.rb
 - lib/soapy_cake/response_value.rb
+- lib/soapy_cake/time_converter.rb
 - lib/soapy_cake/version.rb
 - soapy_cake.gemspec
 - spec/fixtures/raw_response.xml
@@ -229,6 +230,7 @@ files:
 - spec/lib/soapy_cake/request_spec.rb
 - spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb
+- spec/lib/soapy_cake/time_converter_spec.rb
 - spec/spec_helper.rb
 - spec/support/admin_method_example.rb
 homepage: http://ad2games.com
@@ -251,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Simple client for the CAKE API
@@ -290,5 +292,6 @@ test_files:
 - spec/lib/soapy_cake/request_spec.rb
 - spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb
+- spec/lib/soapy_cake/time_converter_spec.rb
 - spec/spec_helper.rb
 - spec/support/admin_method_example.rb