govdelivery-tms 0.8.2 → 0.8.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdf82ccfb0673c58b8eb65e498cb81fc4840859a
+  data.tar.gz: e0061974613e76215c69fd7dff98f7eea1b6033f
+SHA512:
+  metadata.gz: 1585d7cb1099b43919f268a91ed155e97b30f0394d37cb3863ff933e402bce6ce6ea58438ce9586a2f88f8d9f53d3f36911846b085f1c9cf19714afe9ea2dbb9
+  data.tar.gz: 69cf8905b65b09871ddf2f0b303e05ec83cc3c170b4b0aa71f0bf3dcce713e7b5650abcc9209e7ee1627a56875453e096520bf9b3da69361224a1d4c4515a609

data/Gemfile

@@ -1,14 +1,13 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem "appraisal"
+  gem 'appraisal'
   gem 'rspec', '~> 3.2.0'
   gem 'rspec-its'
   gem 'rake'
-  gem 'redcarpet', :platform => :ruby
+  gem 'redcarpet', platform: :ruby
   gem 'yard'
   gem 'mail'
-  gem 'rubygems-tasks', :git => 'https://github.com/postmodern/rubygems-tasks.git', :platform => :ruby
+  gem 'rubygems-tasks', git: 'https://github.com/postmodern/rubygems-tasks.git', platform: :ruby
 end
-

data/README.md

@@ -91,38 +91,6 @@ message.recipients.build(:email=>'bill@example.com')
 message.post
 ```
 
-### Obtaining IPAWS Ack ###
-```ruby
-client.ipaws_acknowledgement.get
-client.ipaws_acknowledgement.ACK # "PONG"
-```
-
-### Obtaining IPAWS COG Profile
-```ruby
-client.ipaws_cog_profile.get
-client.ipaws_cog_profile.attributes # {:cogid=>"120082", :name=>"GovDelivery" ... }
-```
-
-### Determining NWEM COG Authorization ###
-```ruby
-client.ipaws_nwem_authorization.get
-client.ipaws_nwem_authorization.cogid # true
-```
-
-### Obtaining NWEM Auxilary Data (Authorized areas) ###
-```ruby
-client.ipaws_nwem_areas.get
-client.ipaws_nwem_areas.collection.first.countyFipsCd # "51013"
-```
-
-### Sending an IPAWS Alert ###
-```ruby
-alert = client.ipaws_alerts.build({ identifier: "CAP12-TEST-12345", sender: 'test@open.com' ...})
-alert.post # true
-alert.ipaws_response # { "identifier"=>"CAP12-TEST-1397743203", "statuses"=> [{"CHANNELNAME"=>"CAPEXCH" ... }]}
-```
-
-
 Webhooks
 -------
 ### POST to a URL when a recipient is blacklisted (i.e. to remove from your list)  

data/Rakefile

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bundler/setup"
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 unless defined?(JRUBY_VERSION)
   require 'rubygems/tasks'
@@ -15,6 +15,4 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 
-
-task :default => :spec
-
+task default: :spec

data/govdelivery-tms.gemspec

@@ -1,30 +1,30 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "govdelivery/tms/version"
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'govdelivery/tms/version'
 
 Gem::Specification.new do |s|
-  s.name        = "govdelivery-tms"
+  s.name        = 'govdelivery-tms'
   s.version     = GovDelivery::TMS::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["GovDelivery"]
-  s.email       = ["support@govdelivery.com"]
-  s.homepage    = "http://govdelivery.com"
-  s.summary     = %q{A ruby client to interact with the GovDelivery TMS REST API.}
-  s.description = %q{A reference implementation, written in Ruby,
+  s.authors     = ['GovDelivery']
+  s.email       = ['support@govdelivery.com']
+  s.homepage    = 'http://govdelivery.com'
+  s.summary     = 'A ruby client to interact with the GovDelivery TMS REST API.'
+  s.description = "A reference implementation, written in Ruby,
                      to interact with GovDelivery's TMS API. The client is
-                     compatible with Ruby 1.9 and 2.0. }
+                     compatible with Ruby 1.9 and 2.0. "
 
-  s.add_runtime_dependency "activesupport"
-  s.add_runtime_dependency "faraday"
-  s.add_runtime_dependency "faraday_middleware"
+  s.add_runtime_dependency 'activesupport'
+  s.add_runtime_dependency 'faraday'
+  s.add_runtime_dependency 'faraday_middleware'
 
-  s.files       = %w{
+  s.files       = %w(
     Gemfile
     README.md
     Rakefile
     govdelivery-tms.gemspec
-  } + Dir["lib/**/*"]
+  ) + Dir['lib/**/*']
 
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 end

data/lib/govdelivery-tms.rb

@@ -33,13 +33,4 @@ require 'govdelivery/tms/resource/command_type'
 require 'govdelivery/tms/resource/command_action'
 require 'govdelivery/tms/resource/command'
 require 'govdelivery/tms/resource/keyword'
-require 'govdelivery/tms/resource/ipaws_static_resource'
-require 'govdelivery/tms/resource/ipaws_category'
-require 'govdelivery/tms/resource/ipaws_event_code'
-require 'govdelivery/tms/resource/ipaws_response_type'
-require 'govdelivery/tms/resource/ipaws_acknowledgement'
-require 'govdelivery/tms/resource/ipaws_cog_profile'
-require 'govdelivery/tms/resource/ipaws_nwem_authorization'
-require 'govdelivery/tms/resource/ipaws_nwem_area'
-require 'govdelivery/tms/resource/ipaws_alert'
 require 'govdelivery/tms/resource/webhook'

data/lib/govdelivery/tms/base.rb

@@ -23,15 +23,13 @@ module GovDelivery::TMS #:nodoc:
       end
 
       def new_record?
-        !!self.new_record
+        !!new_record
       end
 
       def href=(href)
-        self.new_record=false
-        @href=href
+        self.new_record = false
+        @href = href
       end
     end
-
   end
-
-end
+end

data/lib/govdelivery/tms/client.rb

@@ -6,7 +6,7 @@ class GovDelivery::TMS::Client
 
   attr_accessor :connection, :href, :api_root, :logger
 
-  DEFAULTS = {api_root: 'https://tms.govdelivery.com', logger: nil}.freeze
+  DEFAULTS = { api_root: 'https://tms.govdelivery.com', logger: nil }.freeze
 
   # Create a new client and issue a request for the available resources for a given account.
   #
@@ -29,8 +29,8 @@ class GovDelivery::TMS::Client
     discover!
   end
 
-  def connect!(auth_token, options={})
-    self.connection = GovDelivery::TMS::Connection.new({auth_token: auth_token, api_root: api_root, logger: logger}.merge!(options))
+  def connect!(auth_token, options = {})
+    self.connection = GovDelivery::TMS::Connection.new({ auth_token: auth_token, api_root: api_root, logger: logger }.merge!(options))
   end
 
   def discover!
@@ -41,14 +41,14 @@ class GovDelivery::TMS::Client
   def get(href)
     response = raw_connection.get(href)
     case response.status
-      when 500..599
-        raise GovDelivery::TMS::Request::Error.new(response.status)
-      when 401..499
-        raise GovDelivery::TMS::Request::Error.new(response.status)
-      when 202
-        raise GovDelivery::TMS::Request::InProgress.new(response.body['message'])
-      else
-        return response
+    when 500..599
+      fail GovDelivery::TMS::Request::Error.new(response.status)
+    when 401..499
+      fail GovDelivery::TMS::Request::Error.new(response.status)
+    when 202
+      fail GovDelivery::TMS::Request::InProgress.new(response.body['message'])
+    else
+      return response
     end
   end
 
@@ -71,10 +71,10 @@ class GovDelivery::TMS::Client
   def delete(href)
     response = raw_connection.delete(href)
     case response.status
-      when 200...299
-        return response
-      else
-        raise GovDelivery::TMS::Request::Error.new(response.status)
+    when 200...299
+      return response
+    else
+      fail GovDelivery::TMS::Request::Error.new(response.status)
     end
   end
 
@@ -93,5 +93,4 @@ class GovDelivery::TMS::Client
     logger.level = debug ? Logger::DEBUG : Logger::INFO
     logger
   end
-
 end

data/lib/govdelivery/tms/collection_resource.rb

@@ -7,31 +7,30 @@ module GovDelivery::TMS::CollectionResource
     include GovDelivery::TMS::Base
     attr_accessor :collection
 
-    def initialize(client, href, items=nil)
+    def initialize(client, href, items = nil)
       super(client, href)
       if items
         initialize_collection_from_items(items)
       else
         self.collection = []
       end
-
     end
 
     def get
       response = client.get(href)
       initialize_collection_from_items(response.body)
-      #setup page links from header
+      # setup page links from header
       links = LinkHeader.parse(response.headers['link']).to_a.collect do |a|
-        {a[1][0].last => a[0]}
+        { a[1][0].last => a[0] }
       end
       parse_links(links)
       self
     end
 
-    def build(attributes=nil)
-      thing = instance_class(self.class).new(client, self.href, attributes || {})
+    def build(attributes = nil)
+      thing = instance_class(self.class).new(client, href, attributes || {})
       thing.new_record = true
-      self.collection << thing
+      collection << thing
       thing
     end
 
@@ -40,7 +39,7 @@ module GovDelivery::TMS::CollectionResource
     end
 
     def to_s
-      "<#{self.class.inspect} href=#{self.href} collection=#{self.collection.inspect}>"
+      "<#{self.class.inspect} href=#{href} collection=#{collection.inspect}>"
     end
 
     private

data/lib/govdelivery/tms/connection.rb

@@ -4,13 +4,13 @@ class GovDelivery::TMS::Connection
   def get(href)
     resp = connection.get("#{href}.json")
     if resp.status != 200
-      raise RecordNotFound.new("Could not find resource at #{href} (status #{resp.status})")
+      fail RecordNotFound.new("Could not find resource at #{href} (status #{resp.status})")
     else
       resp.body
     end
   end
 
-  def initialize(opts={})
+  def initialize(opts = {})
     self.auth_token = opts[:auth_token]
     self.api_root = opts[:api_root]
     self.logger = opts[:logger]
@@ -18,8 +18,8 @@ class GovDelivery::TMS::Connection
   end
 
   def setup_connection
-    self.connection = Faraday.new(url: self.api_root) do |faraday|
-      faraday.use GovDelivery::TMS::Logger, self.logger if self.logger
+    self.connection = Faraday.new(url: api_root) do |faraday|
+      faraday.use GovDelivery::TMS::Logger, logger if logger
       faraday.request :json
       faraday.headers['X-AUTH-TOKEN'] = auth_token
       faraday.headers[:user_agent] = "GovDelivery Ruby GovDelivery::TMS::Client #{GovDelivery::TMS::VERSION}"

data/lib/govdelivery/tms/errors.rb

@@ -1,18 +1,18 @@
 module GovDelivery::TMS
   module Request
-# The generic TMS error class
+    # The generic TMS error class
     class Error < StandardError
       attr_reader :code
 
       def initialize(code)
         super("HTTP Error: #{code}")
-        @code=code
+        @code = code
       end
     end
 
     # Raised when a recipient list is still being constructed and a request is made to view the
     # recipient list for a message.
-    class InProgress < StandardError;end
+    class InProgress < StandardError; end
   end
 
   module Errors
@@ -22,8 +22,8 @@ module GovDelivery::TMS
       end
     end
     class NoRelation < StandardError
-      def initialize(rel=nil, obj=nil)
-        message = "no link relation "
+      def initialize(rel = nil, obj = nil)
+        message = 'no link relation '
         message << "'#{rel}' " if rel
         message << 'is available'
         message << " for #{obj}" if obj
@@ -40,7 +40,6 @@ module GovDelivery::TMS
         else
           super(record_or_string)
         end
-
       end
     end
     class InvalidPost < InvalidVerb
@@ -50,9 +49,9 @@ module GovDelivery::TMS
     class InvalidDelete < InvalidVerb
     end
     class InvalidGet < StandardError
-      def initialize(message=nil)
+      def initialize(message = nil)
         super(message || "Can't GET a resource after an invalid POST; either create a new object or fix errors")
       end
     end
   end
-end
+end

data/lib/govdelivery/tms/instance_resource.rb

@@ -89,41 +89,39 @@ module GovDelivery::TMS::InstanceResource
       setup_collection(attr, GovDelivery::TMS.const_get(tms_class))
     end
 
-    def setup_attributes(attrs, readonly=false)
+    def setup_attributes(attrs, readonly = false)
       attrs.map(&:to_sym).each do |property|
-        self.send :define_method, :"#{property}=", &lambda { |v| @attributes[property] = v } unless readonly
-        self.send :define_method, property.to_sym, &lambda { @attributes[property] }
+        send :define_method, :"#{property}=", &lambda { |v| @attributes[property] = v } unless readonly
+        send :define_method, property.to_sym, &lambda { @attributes[property] }
       end
     end
 
-    def setup_collection(property, klass=nil)
+    def setup_collection(property, klass = nil)
       if klass
         custom_class_names[property] = klass
       else
         klass ||= GovDelivery::TMS.const_get(property.to_s.capitalize)
       end
 
-      self.send :define_method, property.to_sym, &lambda { @attributes[property] ||= klass.new(self.client, nil, nil) }
+      send :define_method, property.to_sym, &lambda { @attributes[property] ||= klass.new(self.client, nil, nil) }
     end
   end
 
   module InstanceMethods
     attr_reader :links
 
-    def initialize(client, href=nil, attrs=nil)
+    def initialize(client, href = nil, attrs = nil)
       super(client, href)
       @attributes = {}
       @links = {}
       set_attributes_from_hash(attrs) if attrs
     end
 
-    def attributes
-      @attributes
-    end
+    attr_reader :attributes
 
     def get
-      raise GovDelivery::TMS::Errors::InvalidGet if self.new_record?
-      process_response(client.get(self.href), :get) && self
+      fail GovDelivery::TMS::Errors::InvalidGet if self.new_record?
+      process_response(client.get(href), :get) && self
     end
     alias_method :get!, :get
 
@@ -133,7 +131,7 @@ module GovDelivery::TMS::InstanceResource
     end
 
     def post!
-      self.post or raise GovDelivery::TMS::Errors::InvalidPost.new(self)
+      post || fail(GovDelivery::TMS::Errors::InvalidPost.new(self))
     end
 
     def put
@@ -141,28 +139,28 @@ module GovDelivery::TMS::InstanceResource
     end
 
     def put!
-      process_response(client.put(self), :put) or raise GovDelivery::TMS::Errors::InvalidPut.new(self)
+      process_response(client.put(self), :put) || fail(GovDelivery::TMS::Errors::InvalidPut.new(self))
     end
 
     def delete
-      process_response(client.delete(self.href), :delete)
+      process_response(client.delete(href), :delete)
     end
 
     def delete!
-      process_response(client.delete(self.href), :delete) or raise GovDelivery::TMS::Errors::InvalidDelete.new(self)
+      process_response(client.delete(href), :delete) || fail(GovDelivery::TMS::Errors::InvalidDelete.new(self))
     end
 
     def to_s
-      "<#{self.class.inspect}#{' href=' + self.href if self.href} attributes=#{@attributes.inspect}>"
+      "<#{self.class.inspect}#{' href=' + href if href} attributes=#{@attributes.inspect}>"
     end
 
     def to_json
       json_hash = {}
       self.class.writeable_attributes.each do |attr|
-        json_hash[attr] = self.send(attr)
+        json_hash[attr] = send(attr)
       end
       self.class.collection_attributes.each do |coll|
-        json_hash[coll] = self.send(coll).to_json
+        json_hash[coll] = send(coll).to_json
       end
       self.class.linkable_attributes.each do |attr|
         json_hash[:_links] ||= {}
@@ -181,29 +179,27 @@ module GovDelivery::TMS::InstanceResource
       self.response = response
       error_class   = GovDelivery::TMS::Errors.const_get("Invalid#{method.to_s.capitalize}")
       case response.status
-        when 204
-          return true
-        when 200..299
-          set_attributes_from_hash(response.body) if response.body.is_a?(Hash)
-          @links = {}
-          self.new_record=false
-          return true
-        when 401
-          raise error_class.new("401 Not Authorized")
-        when 404
-          raise(error_class.new("Can't POST to #{self.href}"))
-        when 500..599
-          raise(GovDelivery::TMS::Errors::ServerError.new(response))
-        else # 422?
-          if response.body['errors']
-            self.errors = response.body['errors']
-          end
+      when 204
+        return true
+      when 200..299
+        set_attributes_from_hash(response.body) if response.body.is_a?(Hash)
+        @links = {}
+        self.new_record = false
+        return true
+      when 401
+        fail error_class.new('401 Not Authorized')
+      when 404
+        fail(error_class.new("Can't POST to #{href}"))
+      when 500..599
+        fail(GovDelivery::TMS::Errors::ServerError.new(response))
+      else # 422?
+        self.errors = response.body['errors'] if response.body['errors']
       end
-      return false
+      false
     end
 
     def set_attributes_from_hash(hash)
-      hash.reject { |k, _| k=~/^_/ }.each do |property, value|
+      hash.reject { |k, _| k =~ /^_/ }.each do |property, value|
         if self.class.collection_attributes.include?(property.to_sym)
           klass                        = self.class.custom_class_names[property] || GovDelivery::TMS.const_get(property.to_s.capitalize)
           @attributes[property.to_sym] = klass.new(client, nil, value)
@@ -214,6 +210,5 @@ module GovDelivery::TMS::InstanceResource
       self.errors = hash['errors']
       parse_links(hash['_links'])
     end
-
   end
-end
+end