easypost 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67ae6ddf6e3bdb7a926de241245aff55792b0281
-  data.tar.gz: 818f5cfead41f0ac5ec25214884249d232164cc6
+  metadata.gz: 022e41326d9ad6741c522ddc51cdee8169a0132a
+  data.tar.gz: 389053b0e140ead7d54488ced5c215f79d4a9930
 SHA512:
-  metadata.gz: ed752b2c794b8ece0f10f83ca5d554a33963bc5dbf3bf75cd1ac5f400ccd1d421f3ddbb421586d731b332c39826ffa285561d01967306a0d04cbb95eab271263
-  data.tar.gz: 731107bae2e07e53ef5ff2540a8df9ab59c37765976dabda1a7a2ef9094fee56855233dd849a474156f871ceab720c27af246b16a237dee08df60af754e639a3
+  metadata.gz: b4dd67994b147e1de7d0ba0b513e0e44203e10ecaa236c7a15d475b956746c5a2720d7fec643aaece62731bbc7e05b2a14748df432a6761f1c17de6a2f9dda5c
+  data.tar.gz: d2a15deccdee35141fb29bf0da7eb1c6d71fdb76520c40eed8ed3eb0fa0b7ed0c28ef5e354c31f3704d54d637b860851f5c35736c2ff87cd6e14e5b86e82924d

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 2.4.0 2016-12-08
+
+* Add report resource to ruby client
+
 === 2.3.0 2016-11-25
 
 * Updated dependencies to allow rest-client 2.0.0 and above

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/VERSION

@@ -1 +1 @@
-2.3.0
+2.4.0

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.0.0

data/lib/easypost.rb

@@ -31,6 +31,7 @@ require 'easypost/printer'
 require 'easypost/print_job'
 require 'easypost/carrier_account'
 require 'easypost/user'
+require 'easypost/report'
 
 require 'easypost/error'
 

data/lib/easypost/report.rb

@@ -0,0 +1,47 @@
+module EasyPost
+  class Report < Resource
+    REPORT_TYPES = { shprep: 'shipment', plrep: 'payment_log', trkrep: 'tracker' }
+
+    def self.create(params={}, api_key=nil)
+      url = self.url
+      wrapped_params = {}
+      wrapped_params[class_name.to_sym] = params
+
+      if REPORT_TYPES.values.include?(params[:type].to_s)
+        url += "/#{params[:type]}"
+      else
+        raise Error.new("Undetermined Report Type")
+      end
+
+      response, api_key = EasyPost.request(:post, url, api_key, params)
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+
+    def self.retrieve(params, api_key=nil)
+      url = self.url
+      obj_id = params[:id].split("_")[0]
+
+      if REPORT_TYPES.has_key?(obj_id.to_sym)
+        url += "/#{REPORT_TYPES[obj_id.to_sym]}/#{params[:id]}"
+      else
+        raise Error.new("Undetermined Report Type")
+      end
+
+      response, api_key = EasyPost.request(:get, url, api_key, params)
+      return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
+    end
+
+    def self.all(filters={}, api_key=nil)
+      url = self.url
+
+      if REPORT_TYPES.values.include?(filters[:type].to_s)
+        url += "/#{filters[:type]}"
+      else
+        raise Error.new("Undetermined Report Type")
+      end
+
+      response, api_key = EasyPost.request(:get, url, api_key, filters)
+      return EasyPost::Util::convert_to_easypost_object(response, api_key) if response
+    end
+  end
+end

data/lib/easypost/util.rb

@@ -38,7 +38,8 @@ module EasyPost
         'Printer' => Printer,
         'PrintJob' => PrintJob,
         'CarrierAccount' => CarrierAccount,
-        'User' => User
+        'User' => User,
+        'Report' => Report
       }
 
       prefixes = {
@@ -63,7 +64,7 @@ module EasyPost
         'printer' => Printer,
         'printjob' => PrintJob,
         'ca' => CarrierAccount,
-        'user' => User
+        'user' => User,
       }
 
       case response

data/spec/report_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe EasyPost::Report do
+  [:shipment, :tracker, :payment_log].each do |report_type|
+    context "report" do
+      let(:type) { report_type }
+      let(:type_name) {
+        case type
+        when :shipment
+          "ShipmentReport"
+        when :tracker
+          "TrackerReport"
+        when :payment_log
+          "PaymentLogReport"
+        else
+          raise "Invalid type!"
+        end
+      }
+
+      describe '#create' do
+        it 'creates a report object' do
+          report = EasyPost::Report.create(
+                                           start_date: Date.today - 30,
+                                           end_date: Date.today,
+                                           type: type
+                                           )
+          expect(report.object).to eq type_name
+          # will switch that test on when tracker status is deployed
+          # expect(report.status).to eq 'available'
+        end
+      end
+
+      describe '#retrieve' do
+        it 'retrieves a user created report by public_id' do
+          report_1 = EasyPost::Report.create(
+                                             start_date: Date.today - 30,
+                                             end_date: Date.today,
+                                             type: type
+                                             )
+          report_2 = EasyPost::Report.retrieve(id: report_1.id)
+
+          expect(report_1.object).to eq type_name
+          expect(report_2.object).to eq type_name
+          expect(report_2.id).to eq(report_1.id)
+        end
+      end
+
+      describe '#all' do
+        it 'retrieves all user created reports' do
+          report_1 = EasyPost::Report.create(
+                                             start_date: Date.today - 25,
+                                             end_date: Date.today,
+                                             type: type
+                                             )
+
+          report_2 = EasyPost::Report.create(
+                                             start_date: Date.today - 29,
+                                             end_date: Date.today,
+                                             type: type
+                                             )
+          reports = EasyPost::Report.all(type: type)
+
+          expect(reports.count).to eq 2
+        end
+      end
+    end
+  end
+
+  it 'fails to create a report object' do
+    expect { EasyPost::Report.create(
+      start_date: Date.today - 30,
+      end_date: Date.today,
+      type: 'foobar'
+      ) }.to raise_exception(EasyPost::Error)
+  end
+end

data/spec/user_spec.rb

@@ -64,8 +64,8 @@ describe EasyPost::User do
   #     api_keys = EasyPost::User.all_api_keys
 
   #     my_keys = api_keys.keys
-  #     expect(my_keys.first.mode).to eq("production")
-  #     expect(my_keys.last.mode).to eq("test")
+  #     expect(my_keys.first.mode).to eq("test")
+  #     expect(my_keys.last.mode).to eq("production")
 
   #     me = EasyPost::User.retrieve_me
   #     children_count = me.children.count

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Sawyer Bateman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2016-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - VERSION
 - bin/easypost-irb
+- circle.yml
 - easypost.gemspec
 - lib/easypost.rb
 - lib/easypost/address.rb
@@ -117,6 +118,7 @@ files:
 - lib/easypost/printer.rb
 - lib/easypost/rate.rb
 - lib/easypost/refund.rb
+- lib/easypost/report.rb
 - lib/easypost/resource.rb
 - lib/easypost/scan_form.rb
 - lib/easypost/shipment.rb
@@ -132,6 +134,7 @@ files:
 - spec/item_spec.rb
 - spec/order_spec.rb
 - spec/pickup_spec.rb
+- spec/report_spec.rb
 - spec/shipment_spec.rb
 - spec/spec_helper.rb
 - spec/support/constant.rb
@@ -169,6 +172,7 @@ test_files:
 - spec/item_spec.rb
 - spec/order_spec.rb
 - spec/pickup_spec.rb
+- spec/report_spec.rb
 - spec/shipment_spec.rb
 - spec/spec_helper.rb
 - spec/support/constant.rb