postmark 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17d7c0c5ea350fd8902efaa8e8334dff894fe215
-  data.tar.gz: 17f7871d1544d69b7cf16d75c4ba260048de182c
+  metadata.gz: 55e9f7a191eaed08f4f65b7291d679dbba6665bf
+  data.tar.gz: 04cba05dd0d1f5a872a4b408d9ffb0d10511e782
 SHA512:
-  metadata.gz: 38df57ae61ce36c80870832444d017083e1bff043901823eb675384ae25df1366f420170abf41059a7601d7a6a2c7e26866a15abf8c5b98fa7fa30b7d8cbeeb8
-  data.tar.gz: 4dcacb79aec065cf65445da357f0b3e275911da17881291124dacd70b0bccacb1a3d69b4779f34f010692b7667710a0e0b6c8214a00af557b65d86746fc0a499
+  metadata.gz: ff849c87686ddf3eae5af58661de0c43888d1e82910081b1c07ac4bc6d8f44a29a18b9e6938c5db020c46145d36dbd35b71bec24383ead16e991757f99829868
+  data.tar.gz: 77eaa67674a06887f47584485cfa2e6666d5c6d1f3dd75f969d5af97c38cccbe7109c303cc56aba21d90fc4adc641aaef606e2cb27d014f04012e4f471d5e24d

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 .rvmrc
 .idea
+bin/*

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
 - 1.8.7
 - 1.9.3
 - 2.0.0
-- 2.1.0
+- 2.1.6
+- 2.2.2
 - jruby-19mode
 script: bundle exec rake spec

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = Changelog
 
+== 1.7.0
+
+* Add methods to access stats API endpoints.
+
 == 1.6.0
 
 * Add methods to access new templates API endpoints.

data/README.md

@@ -564,6 +564,11 @@ If you ever need to access your messages or their metadata (i.e. open tracking i
 
 [The Templates API](https://github.com/wildbit/postmark-gem/wiki/The-Templates-API-support) can be used to fully manage your templates.
 
+## The Stats API Support
+
+[The Stats API](https://github.com/wildbit/postmark-gem/wiki/) can be used to access statistics on your emails sent by date and tag.
+
+
 ## ActiveModel-like Interface For Bounces
 
 To provide an interface similar to ActiveModel for bounces, the Postmark gem adds

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/lib/postmark/api_client.rb

@@ -221,6 +221,22 @@ module Postmark
       end
     end
 
+    def get_stats_totals(options = {})
+      format_response(http_client.get('stats/outbound', options))
+    end
+
+    def get_stats_counts(stat, options = {})
+      url = "stats/outbound/#{stat}"
+
+      url << "/#{options[:type]}" if options.has_key?(:type)
+
+      response = format_response(http_client.get(url, options))
+
+      response[:days].map! { |d| HashHelper.to_ruby(d) }
+
+      response
+    end
+
     protected
 
     def in_batches(messages)

data/lib/postmark/version.rb

@@ -1,3 +1,3 @@
 module Postmark
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/spec/unit/postmark/api_client_spec.rb

@@ -409,7 +409,7 @@ describe Postmark::ApiClient do
       expect(subject.opens.first(5).count).to eq(1)
     end
 
-  end  
+  end
 
   describe '#get_opens' do
     let(:http_client) { subject.http_client }
@@ -827,4 +827,84 @@ describe Postmark::ApiClient do
       r.should have_key(:message_id)
     end
   end
+
+  describe '#get_stats_totals' do
+    let(:response) do
+      {
+        "Sent" => 615,
+        "BounceRate" => 10.406,
+      }
+    end
+    let(:http_client) { subject.http_client }
+
+    it 'converts response to ruby format' do
+      http_client.should_receive(:get).with('stats/outbound', { :tag => 'foo' }) { response }
+      r = subject.get_stats_totals(:tag => 'foo')
+      r.should have_key(:sent)
+      r.should have_key(:bounce_rate)
+    end
+  end
+
+  describe '#get_stats_counts' do
+    let(:response) do
+      {
+        "Days" => [
+          {
+            "Date" => "2014-01-01",
+            "Sent" => 140
+          },
+          {
+            "Date" => "2014-01-02",
+            "Sent" => 160
+          },
+          {
+            "Date" => "2014-01-04",
+            "Sent" => 50
+          },
+          {
+            "Date" => "2014-01-05",
+            "Sent" => 115
+          }
+        ],
+        "Sent" => 615
+      }
+    end
+    let(:http_client) { subject.http_client }
+
+    it 'converts response to ruby format' do
+      http_client.should_receive(:get).with('stats/outbound/sends', { :tag => 'foo' }) { response }
+      r = subject.get_stats_counts(:sends, :tag => 'foo')
+      r.should have_key(:days)
+      r.should have_key(:sent)
+
+      first_day = r[:days].first
+
+      first_day.should have_key(:date)
+      first_day.should have_key(:sent)
+    end
+
+    it 'uses fromdate that is passed in' do
+      http_client.should_receive(:get).with('stats/outbound/sends', { :tag => 'foo', :fromdate => '2015-01-01' }) { response }
+      r = subject.get_stats_counts(:sends, :tag => 'foo', :fromdate => '2015-01-01')
+      r.should have_key(:days)
+      r.should have_key(:sent)
+
+      first_day = r[:days].first
+
+      first_day.should have_key(:date)
+      first_day.should have_key(:sent)
+    end
+
+    it 'uses stats type that is passed in' do
+      http_client.should_receive(:get).with('stats/outbound/opens/readtimes', { :tag => 'foo', :type => :readtimes }) { response }
+      r = subject.get_stats_counts(:opens, :type => :readtimes, :tag => 'foo')
+      r.should have_key(:days)
+      r.should have_key(:sent)
+
+      first_day = r[:days].first
+
+      first_day.should have_key(:date)
+      first_day.should have_key(:sent)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postmark
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Petyo Ivanov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.7
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Official Postmark API wrapper.