easypost 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5b2a2aec96dd52db2877a8d37d8fb45864c6b5
-  data.tar.gz: 64c58f1e552166b38e9ce5a847c8b309ba597f87
+  metadata.gz: 1b360f6133e438fbd6da1c82a6d3fd896fc6e5c0
+  data.tar.gz: 0a428545bec4b22c37612d1880b7b9ece706136d
 SHA512:
-  metadata.gz: c47dca1f33b6a3815e81e2de2e4086317ecf22991e5d4f9768b66458cc42824e1daad419a1ea2fb70d558c0234a2fadcccebfb632f1317d406abbc9edbeedf30
-  data.tar.gz: 429562b83a019209a6c246361a9ec47dc1c8bcf299ec2c7f5533de15f238f3f7af03be96149fddc5fd611e9571b01411c91a03e46de3674f0563a2ec61e3cc39
+  metadata.gz: 154082e65747ede8cb1fbb9d06c99ae0ad4d336c7b52fecd8a3c51ab35bfab6dbde9d7a3e04e603e7eb4689b2e7f4419b51be37667ffdd8db6ddbcf695f2528d
+  data.tar.gz: 8d62d3abafc9f1df1a67199b8653a2ca772ef371c60b3a45f615b663b4d4fbee7c8080743fdc0da3c9a00e9272fa18e513fb69f1da3d58bc6ad031af8a79bd4f

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 2.6.0 2017-01-17
+
+* Add basic CRUD methods for Webhooks
+
 === 2.5.0 2016-12-19
 
 * Add prefixes to report in utils

data/VERSION

@@ -1 +1 @@
-2.5.0
+2.6.0

data/lib/easypost.rb

@@ -32,6 +32,7 @@ require 'easypost/print_job'
 require 'easypost/carrier_account'
 require 'easypost/user'
 require 'easypost/report'
+require 'easypost/webhook'
 
 require 'easypost/error'
 

data/lib/easypost/util.rb

@@ -42,7 +42,8 @@ module EasyPost
         'Report' => Report,
         'ShipmentReport' => Report,
         'PaymentLogReport' => Report,
-        'TrackerReport' => Report
+        'TrackerReport' => Report,
+        'Webhook' => Webhook
       }
 
       prefixes = {
@@ -70,7 +71,8 @@ module EasyPost
         'user' => User,
         'shprep' => Report,
         'plrep' => Report,
-        'trkrep' => Report
+        'trkrep' => Report,
+        'hook' => Webhook
       }
 
       case response

data/lib/easypost/webhook.rb

@@ -0,0 +1,28 @@
+module EasyPost
+  class Webhook < Resource
+    def update(params={})
+      unless self.id
+        raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
+      end
+      instance_url = "#{self.class.url}/#{CGI.escape(id)}"
+
+      response, api_key = EasyPost.request(:put, instance_url, @api_key, params)
+      self.refresh_from(response, api_key, true)
+
+      return self
+    end
+
+    def delete
+      # Note: This method is redefined here since the "url" method conflicts with the objects field
+      unless self.id
+        raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
+      end
+      instance_url = "#{self.class.url}/#{CGI.escape(id)}"
+
+      response, api_key = EasyPost.request(:delete, instance_url, @api_key)
+      refresh_from(response, api_key)
+
+      return self
+    end
+  end
+end

data/spec/webhook_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe EasyPost::Webhook do
+  let(:url)       { "http://example.com" }
+  let(:webhook)   { EasyPost::Webhook.create({url: url}) }
+
+  context 'with automated cleanup' do
+    after do
+      webhook.delete()
+    end
+
+    describe '#create' do
+      it 'creates' do
+        expect(webhook.id).not_to       be_nil
+        expect(webhook.url).to          eq(url)
+        expect(webhook.mode).to         eq("test")
+        expect(webhook.disabled_at).to  be_nil
+        expect(webhook.class).to        eq(EasyPost::Webhook)
+      end
+    end
+
+    describe '#retrieve' do
+      it 'retrieves' do
+        hook = EasyPost::Webhook.retrieve(webhook.id)
+
+        expect(hook.id).to           eq(webhook.id)
+        expect(hook.url).to          eq(url)
+        expect(hook.mode).to         eq("test")
+        expect(hook.disabled_at).to  be_nil
+        expect(hook.class).to        eq(EasyPost::Webhook)
+      end
+    end
+
+    describe '#index' do
+      it 'indexes with the recently created webhook as the last one' do
+        webhook
+        webhooks = EasyPost::Webhook.all({})
+
+        hook = webhooks["webhooks"].last
+
+        expect(hook.id).to           eq(webhook.id)
+        expect(hook.url).to          eq(url)
+        expect(hook.mode).to         eq("test")
+        expect(hook.disabled_at).to  be_nil
+        expect(hook.class).to        eq(EasyPost::Webhook)
+      end
+    end
+
+    describe '#retrieve' do
+      it 'retrieves' do
+        hook = webhook.update({})
+
+        expect(hook.id).to           eq(webhook.id)
+        expect(hook.url).to          eq(url)
+        expect(hook.mode).to         eq("test")
+        expect(hook.disabled_at).to  be_nil
+        expect(hook.class).to        eq(EasyPost::Webhook)
+      end
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes the tracker' do
+      webhook.delete()
+
+      begin
+        EasyPost::Webhook.retrieve(webhook.id)
+      rescue EasyPost::Error => e
+        expect(e.http_status).to eq(404)
+        expect(e.code).to        eq("NOT_FOUND")
+        expect(e.message).to     eq("The requested resource could not be found.")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easypost
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Sawyer Bateman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -126,6 +126,7 @@ files:
 - lib/easypost/user.rb
 - lib/easypost/util.rb
 - lib/easypost/version.rb
+- lib/easypost/webhook.rb
 - spec/address_spec.rb
 - spec/batch_spec.rb
 - spec/carrier_account_spec.rb
@@ -140,6 +141,7 @@ files:
 - spec/support/constant.rb
 - spec/tracker_spec.rb
 - spec/user_spec.rb
+- spec/webhook_spec.rb
 homepage: https://www.easypost.com/docs
 licenses: []
 metadata: {}
@@ -178,3 +180,4 @@ test_files:
 - spec/support/constant.rb
 - spec/tracker_spec.rb
 - spec/user_spec.rb
+- spec/webhook_spec.rb