govdelivery-tms 0.8.0

data/spec/ipaws_event_codes_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe TMS::IpawsEventCodes do
+  context "loading Ipaws event codes" do
+    let(:client) { double('client') }
+    let(:event_codes) { TMS::IpawsEventCodes.new(client, '/ipaws/event_codes') }
+    it 'should GET itself' do
+      body = [
+        {
+          value: 'ADR',
+          description: 'Administrative Message/Follow up Statement',
+          cap_exchange: true,
+          core_ipaws_profile: true,
+          nwem: true,
+          eas_and_public: true,
+          cmas: true
+        },
+        {
+          value: 'AVA',
+          description: 'Avalanche Watch',
+          cap_exchange: true,
+          core_ipaws_profile: true,
+          nwem: true,
+          eas_and_public: true,
+          cmas: false        }
+      ]
+      client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {}))
+      event_codes.get
+      event_codes.collection.length.should == 2
+      event_codes.collection.each do |event_code|
+        event_code.should be_an_instance_of(TMS::IpawsEventCode)
+      end
+    end
+  end
+end

data/spec/ipaws_nwem_areas_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe TMS::IpawsNwemAreas do
+
+  it 'gets IPAWS NWEM areas from client' do
+    client = double(:client)
+    response_body = [
+      {
+        "countyFipsCd"=>"51013",
+        "countyName"=>"Arlington",
+        "geoType"=>"C",
+        "stateCd"=>"VA",
+        "stateFips"=>"51",
+        "stateName"=>"Virginia",
+        "zoneCd"=>"054",
+        "zoneName"=>"Arlington/Falls Church/Alexandria"
+      },
+      {
+        "countyFipsCd"=>"51510",
+        "countyName"=>"City of Alexandria",
+        "geoType"=>"C",
+        "stateCd"=>"VA",
+        "stateFips"=>"51",
+        "stateName"=>"Virginia",
+        "zoneCd"=>"054",
+        "zoneName"=>"Arlington/Falls Church/Alexandria"
+      }
+    ]
+    nwem_areas = TMS::IpawsNwemAreas.new(client, '/ipaws/nwem_areas')
+
+    nwem_areas.client.should_receive('get').with(nwem_areas.href).and_return(
+      double('response', :status => 200, :body => response_body, :headers => {})
+    )
+    nwem_areas.get.should == nwem_areas
+    nwem_areas.collection.size.should == 2
+
+    nwem_area = nwem_areas.collection[0]
+    nwem_area.countyFipsCd.should == '51013'
+    nwem_area.countyName.should == 'Arlington'
+    nwem_area.geoType.should == 'C'
+    nwem_area.stateCd.should == 'VA'
+    nwem_area.stateFips.should == '51'
+    nwem_area.stateName.should == 'Virginia'
+    nwem_area.zoneCd.should == '054'
+    nwem_area.zoneName.should == 'Arlington/Falls Church/Alexandria'
+
+    nwem_area = nwem_areas.collection[1]
+    nwem_area.countyFipsCd.should == '51510'
+    nwem_area.countyName.should == 'City of Alexandria'
+    nwem_area.geoType.should == 'C'
+    nwem_area.stateCd.should == 'VA'
+    nwem_area.stateFips.should == '51'
+    nwem_area.stateName.should == 'Virginia'
+    nwem_area.zoneCd.should == '054'
+    nwem_area.zoneName.should == 'Arlington/Falls Church/Alexandria'
+  end
+
+end

data/spec/ipaws_nwem_authorization_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe TMS::IpawsNwemAuthorization do
+
+  it 'gets IPAWS NWEM Authorization from client' do
+    client = double(:client)
+    response_body = { "cogid" => "true" }
+    nwem_authorization = TMS::IpawsNwemAuthorization.new(client, '/ipaws/nwem_authorization', {})
+    nwem_authorization.client.should_receive('get').with(nwem_authorization.href).and_return(
+      double('response', :status => 200, :body => response_body)
+    )
+    nwem_authorization.get.should == nwem_authorization
+    nwem_authorization.cogid.should == "true"
+  end
+
+end

data/spec/keyword_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe TMS::Keyword do
+  context "creating a new keyword" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @keyword = TMS::Keyword.new(client, nil, {:name => 'LOL', :response_text => 'very funny!'})
+    end
+    it 'should initialize with attrs' do
+      @keyword.name.should == 'LOL'
+      @keyword.response_text.should == 'very funny!'
+    end
+    it 'should post successfully' do
+      response = {:name => 'lol'}
+      @keyword.client.should_receive('post').with(@keyword).and_return(double('response', :status => 201, :body => response))
+      @keyword.post
+      @keyword.name.should == 'lol'
+      @keyword.response_text.should == 'very funny!'
+    end
+    it 'should handle errors' do
+      response = {'errors' => {:name => "can't be nil"}}
+      @keyword.client.should_receive('post').with(@keyword).and_return(double('response', :status => 422, :body => response))
+      @keyword.post
+      @keyword.name.should == 'LOL'
+      @keyword.response_text.should == 'very funny!'
+      @keyword.errors.should == {:name => "can't be nil"}
+    end
+  end
+
+  context 'an existing keyword' do
+    let(:client) do
+      double('client')
+    end
+    before do
+      # blank hash prevents the client from doing a GET in the initialize method
+      @keyword = TMS::Keyword.new(client, '/keywords/99', {})
+    end
+    it 'should GET cleanly' do
+      response = {:name => 'FOO', :response_text => 'hello'}
+      @keyword.client.should_receive('get').with(@keyword.href).and_return(double('response', :status => 200, :body => response))
+      @keyword.get
+      @keyword.name.should == 'FOO'
+      @keyword.response_text.should == 'hello'
+    end
+    it 'should PUT cleanly' do
+      @keyword.name = "GOVLIE"
+      response  = {:name => 'govlie', :response_text => nil}
+      @keyword.client.should_receive('put').with(@keyword).and_return(double('response', :status => 200, :body => response))
+      @keyword.put
+      @keyword.name.should == 'govlie'
+      @keyword.response_text.should be_nil
+    end
+    it 'should DELETE cleanly' do
+      @keyword.client.should_receive('delete').with(@keyword.href).and_return(double('response', :status => 200, :body => ''))
+      @keyword.delete
+    end
+  end
+
+
+end

data/spec/keywords_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe TMS::Keywords do
+  context "loading keywords" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @keywords = TMS::Keywords.new(client, '/keywords')
+    end
+    it 'should GET ok' do
+      body = [
+        {"name"=>"services", "_links"=>{"self"=>"/keywords/1"}}, 
+        {"name"=>"subscribe", "_links"=>{"self"=>"/keywords/2"}}
+      ]
+      @keywords.client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {}))
+      @keywords.get
+      @keywords.collection.length.should == 2
+    end
+  end
+end

data/spec/mail/delivery_method_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'mail'
+require 'govdelivery-tms/mail/delivery_method'
+describe TMS::Mail::DeliveryMethod do
+  subject { TMS::Mail::DeliveryMethod.new({}) }
+  let(:client) { double('TMS::Client') }
+  let(:email_messages) { double('email_messages') }
+  let(:tms_message) { double('tms_message', :recipients => double(:build => TMS::Recipient.new('href'))) }
+
+  it 'should work with a basic Mail::Message' do
+    mail = Mail.new do
+      subject 'hi'
+      from '"My mom" <my@mom.com>'
+      to '"A Nice Fellow" <tyler@sink.govdelivery.com>'
+      body '<blink>HI</blink>'
+    end
+    client.stub(:email_messages).and_return(email_messages)
+    subject.stub(:client).and_return(client)
+    email_messages.should_receive(:build).with(
+        :from_name => mail[:from].display_names.first,
+        :subject   => mail.subject,
+        :body      => '<blink>HI</blink>'
+      ).and_return(tms_message)
+    tms_message.should_receive(:post!).and_return(true)
+
+    subject.deliver!(mail)
+  end
+
+  it 'should work with a multipart Mail::Message' do
+    mail = Mail.new do
+      subject 'hi'
+      from '"My mom" <my@mom.com>'
+      to '"A Nice Fellow" <tyler@sink.govdelivery.com>'
+
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body '<blink>HTML</blink>'
+      end
+    end
+    client.stub(:email_messages).and_return(email_messages)
+    subject.stub(:client).and_return(client)
+    email_messages.should_receive(:build).with(
+        :from_name => mail[:from].display_names.first,
+        :subject   => mail.subject,
+        :body      => '<blink>HTML</blink>'
+      ).and_return(tms_message)
+    tms_message.should_receive(:post!).and_return(true)
+
+    subject.deliver!(mail)
+  end
+
+end

data/spec/sms_message_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe TMS::SmsMessage do
+  context "creating a new message" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @message = TMS::SmsMessage.new(client, nil, {:body => '12345678', :created_at => 'BAAAAAD'})
+    end
+    it 'should not render readonly attrs in json hash' do
+      @message.to_json[:body].should == '12345678'
+      @message.to_json[:created_at].should == nil
+    end
+    it 'should initialize with attrs and collections' do
+      @message.body.should == '12345678'
+      @message.recipients.class.should == TMS::Recipients
+    end
+    it 'should post successfully' do
+      response = { :body => 'processed',
+                   :recipients => [{:phone => '22345678'}],
+                   :failed => [{:phone => '22345678'}],
+                   :sent => [{:phone => '22345678'}],
+                    :created_at => 'time'}
+      @message.client.should_receive('post').with(@message).and_return(double('response', :status => 201, :body => response))
+      @message.post
+      @message.body.should == 'processed'
+      @message.created_at.should == 'time'
+      @message.recipients.class.should == TMS::Recipients
+      @message.recipients.collection.first.class.should == TMS::Recipient
+      @message.sent.class.should == TMS::Recipients
+      @message.sent.collection.first.class.should == TMS::Recipient
+      @message.failed.class.should == TMS::Recipients
+      @message.failed.collection.first.class.should == TMS::Recipient
+    end
+    it 'should handle errors' do
+      response = {'errors' => {:body => "can't be nil"}}
+      @message.client.should_receive('post').with(@message).and_return(double('response', :status => 422, :body => response))
+      @message.post
+      @message.body.should == '12345678'
+      @message.errors.should == {:body => "can't be nil"}
+    end
+  end
+
+  context 'an existing message' do
+    let(:client) do
+      double('client')
+    end
+    before do
+      # blank hash prevents the client from doing a GET in the initialize method
+      @message = TMS::SmsMessage.new(client, '/messages/99', {})
+    end
+    it 'should GET cleanly' do
+      response = {:body => 'processed', :recipients => [{:phone => '22345678'}], :created_at => 'time'}
+      @message.client.should_receive('get').with(@message.href).and_return(double('response', :status => 200, :body => response))
+      @message.get
+      @message.body.should == 'processed'
+      @message.created_at.should == 'time'
+    end
+  end
+
+
+end

data/spec/sms_messages_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe TMS::SmsMessages do
+  context "creating a new messages list" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @messages = TMS::SmsMessages.new(client, '/messages')
+    end
+    it 'should GET itself' do
+      body = [{:short_body => 'hi ho', :created_at => 'a while ago'}, {:short_body => 'feel me flow', :created_at => 'longer ago'}]
+      @messages.client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {'link' => "</messages/page/2>; rel=\"next\",</messages/page/11>; rel=\"last\""}))
+
+      @messages.get
+      @messages.collection.length.should == 2
+      @messages.next.href.should == '/messages/page/2'
+      @messages.last.href.should == '/messages/page/11'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+$: << File.expand_path("../lib", __FILE__)
+require 'govdelivery-tms'
+
+class TMS::Horse
+  def initialize(client, href)
+  end
+end
+
+class TMS::Rabbits
+  def initialize(client, href)
+  end
+end
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'rspec/its'
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tms_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe TMS, "version" do
+  it "should exist" do
+    TMS::VERSION.should be_an_instance_of(String)
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: govdelivery-tms
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- GovDelivery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "A reference implementation, written in Ruby,\n                     to
+  interact with GovDelivery's TMS API. The client is\n                     compatible
+  with Ruby 1.9 and 2.0. "
+email:
+- support@govdelivery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- govdelivery-tms.gemspec
+- lib/govdelivery-tms.rb
+- lib/govdelivery-tms/base.rb
+- lib/govdelivery-tms/client.rb
+- lib/govdelivery-tms/collection_resource.rb
+- lib/govdelivery-tms/connection.rb
+- lib/govdelivery-tms/errors.rb
+- lib/govdelivery-tms/instance_resource.rb
+- lib/govdelivery-tms/link_header.rb
+- lib/govdelivery-tms/logger.rb
+- lib/govdelivery-tms/mail/delivery_method.rb
+- lib/govdelivery-tms/resource/collections.rb
+- lib/govdelivery-tms/resource/command.rb
+- lib/govdelivery-tms/resource/command_action.rb
+- lib/govdelivery-tms/resource/command_type.rb
+- lib/govdelivery-tms/resource/email_message.rb
+- lib/govdelivery-tms/resource/email_recipient.rb
+- lib/govdelivery-tms/resource/email_recipient_click.rb
+- lib/govdelivery-tms/resource/email_recipient_open.rb
+- lib/govdelivery-tms/resource/email_template.rb
+- lib/govdelivery-tms/resource/from_address.rb
+- lib/govdelivery-tms/resource/inbound_sms_message.rb
+- lib/govdelivery-tms/resource/ipaws_acknowledgement.rb
+- lib/govdelivery-tms/resource/ipaws_alert.rb
+- lib/govdelivery-tms/resource/ipaws_category.rb
+- lib/govdelivery-tms/resource/ipaws_cog_profile.rb
+- lib/govdelivery-tms/resource/ipaws_event_code.rb
+- lib/govdelivery-tms/resource/ipaws_nwem_area.rb
+- lib/govdelivery-tms/resource/ipaws_nwem_authorization.rb
+- lib/govdelivery-tms/resource/ipaws_nwem_auxilary_data.rb
+- lib/govdelivery-tms/resource/ipaws_response_type.rb
+- lib/govdelivery-tms/resource/ipaws_static_resource.rb
+- lib/govdelivery-tms/resource/keyword.rb
+- lib/govdelivery-tms/resource/recipient.rb
+- lib/govdelivery-tms/resource/sms_message.rb
+- lib/govdelivery-tms/resource/webhook.rb
+- lib/govdelivery-tms/util/core_ext.rb
+- lib/govdelivery-tms/util/hal_link_parser.rb
+- lib/govdelivery-tms/version.rb
+- spec/client_spec.rb
+- spec/command_types_spec.rb
+- spec/email_message_spec.rb
+- spec/email_template_spec.rb
+- spec/errors_spec.rb
+- spec/from_address_spec.rb
+- spec/inbound_sms_messages_spec.rb
+- spec/instance_resource_spec.rb
+- spec/ipaws_acknowledgement_spec.rb
+- spec/ipaws_alerts_spec.rb
+- spec/ipaws_cog_profile_spec.rb
+- spec/ipaws_event_codes_spec.rb
+- spec/ipaws_nwem_areas_spec.rb
+- spec/ipaws_nwem_authorization_spec.rb
+- spec/keyword_spec.rb
+- spec/keywords_spec.rb
+- spec/mail/delivery_method_spec.rb
+- spec/sms_message_spec.rb
+- spec/sms_messages_spec.rb
+- spec/spec_helper.rb
+- spec/tms_spec.rb
+homepage: http://govdelivery.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby client to interact with the GovDelivery TMS REST API.
+test_files:
+- spec/client_spec.rb
+- spec/command_types_spec.rb
+- spec/email_message_spec.rb
+- spec/email_template_spec.rb
+- spec/errors_spec.rb
+- spec/from_address_spec.rb
+- spec/inbound_sms_messages_spec.rb
+- spec/instance_resource_spec.rb
+- spec/ipaws_acknowledgement_spec.rb
+- spec/ipaws_alerts_spec.rb
+- spec/ipaws_cog_profile_spec.rb
+- spec/ipaws_event_codes_spec.rb
+- spec/ipaws_nwem_areas_spec.rb
+- spec/ipaws_nwem_authorization_spec.rb
+- spec/keyword_spec.rb
+- spec/keywords_spec.rb
+- spec/mail/delivery_method_spec.rb
+- spec/sms_message_spec.rb
+- spec/sms_messages_spec.rb
+- spec/spec_helper.rb
+- spec/tms_spec.rb
+has_rdoc: