tms_client 0.0.2

data/lib/tms_client/resource/keyword.rb

@@ -0,0 +1,22 @@
+module TMS #:nodoc:
+  # A Keyword is a word that TMS will detect in an incoming SMS message.  Keywords can have Commands, and
+  # when an incoming text message has a keyword, TMS will execute the keyword's Commands. 
+  #
+  # ==== Attributes  
+  # 
+  # * +name+ - The name of the keyword.
+  #  
+  # === Examples
+  #   keyword = client.keywords.build(:name => "HOWDY")
+  #   keyword.post
+  #   keyword.name = "DOODY"
+  #   keyword.put
+  #   keyword.delete
+  class Keyword
+    include InstanceResource
+
+    writeable_attributes :name
+    collection_attributes :commands
+
+  end
+end

data/lib/tms_client/resource/recipient.rb

@@ -0,0 +1,8 @@
+module TMS #:nodoc:
+  class Recipient
+    include InstanceResource
+
+    writeable_attributes :phone
+    readonly_attributes :formatted_phone, :error_message, :status
+  end
+end

data/lib/tms_client/resource/sms_message.rb

@@ -0,0 +1,9 @@
+module TMS #:nodoc:
+  class SmsMessage
+    include InstanceResource
+
+    writeable_attributes :from, :body, :subject
+    readonly_attributes :created_at, :completed_at
+    collection_attributes :recipients
+  end
+end

data/lib/tms_client/resource/voice_message.rb

@@ -0,0 +1,13 @@
+module TMS #:nodoc:
+  class VoiceMessage
+    include InstanceResource
+
+    writeable_attributes :play_url
+    readonly_attributes :created_at, :completed_at
+    collection_attributes :recipients
+
+    def self.to_s
+      "VoiceMessage"
+    end
+  end
+end

data/lib/tms_client/util/core_ext.rb

@@ -0,0 +1,27 @@
+require 'active_support/inflector'
+
+module TMS::CoreExt
+  def demodulize(path)
+    ActiveSupport::Inflector.demodulize(path)
+  end
+
+  def classify(str)
+    ActiveSupport::Inflector.camelize(str)
+  end
+
+  def singularize(str)
+      ActiveSupport::Inflector.singularize(str)
+    end
+
+  def pluralize(str)
+    ActiveSupport::Inflector.pluralize(str)
+  end
+
+  def tmsify(klassname)
+    ActiveSupport::Inflector.underscore(demodulize(klassname))
+  end
+
+  def instance_class(klass)
+    ActiveSupport::Inflector.constantize(singularize(klass.to_s))
+  end
+end

data/lib/tms_client/util/hal_link_parser.rb

@@ -0,0 +1,50 @@
+module TMS::Util
+  module HalLinkParser
+
+    #def self.included(base)
+    #  base.send(:include, TMS::CoreExt)
+    #end
+
+    def parse_links(_links)
+      @resources = {}
+      return if _links.nil?
+      parse_link(_links) and return if _links.is_a?(Hash)
+      _links.each { |link| parse_link(link) }
+    end
+
+    def subresources
+      @resources
+    end
+
+    protected
+
+    def metaclass
+      @metaclass ||= class << self;
+        self;
+      end
+    end
+
+    def parse_link(link)
+      link.each do |rel, href|
+        if rel == 'self'
+          self.href = href
+        else
+          klass = ::TMS.const_get(classify(rel)) rescue nil
+          klass = self.class if ['first', 'prev', 'next', 'last'].include?(rel)
+          if klass
+            subresources[rel] = klass.new(self.client, href)
+            setup_subresource(link)
+          else
+            puts "Don't know what to do with link rel '#{rel}' for class #{self.class.to_s}!"
+          end
+
+        end
+      end
+    end
+
+    def setup_subresource(link)
+      return unless link
+      link.each { |rel, href| self.metaclass.send(:define_method, rel.to_sym, &lambda { subresources[rel] }) unless rel == 'self' }
+    end
+  end
+end

data/lib/tms_client/version.rb

@@ -0,0 +1,3 @@
+module TMS #:nodoc:
+  VERSION = "0.0.2"
+end

data/lib/tms_client.rb

@@ -0,0 +1,30 @@
+module TMS #:nodoc:
+end
+
+require 'active_support'
+require 'tms_client/version'
+require 'faraday'
+require 'link_header'
+require 'faraday_middleware'
+
+require 'tms_client/util/hal_link_parser'
+require 'tms_client/util/core_ext'
+require 'tms_client/connection'
+require 'tms_client/client'
+require 'tms_client/logger'
+require 'tms_client/base'
+require 'tms_client/instance_resource'
+require 'tms_client/collection_resource'
+require 'tms_client/request'
+
+require 'tms_client/resource/collections'
+require 'tms_client/resource/recipient'
+require 'tms_client/resource/email_recipient'
+require 'tms_client/resource/sms_message'
+require 'tms_client/resource/voice_message'
+require 'tms_client/resource/inbound_message'
+require 'tms_client/resource/command_type'
+require 'tms_client/resource/command'
+require 'tms_client/resource/commands'
+require 'tms_client/resource/keyword'
+require 'tms_client/resource/email'

data/spec/client_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+describe TMS::Client do
+  context "creating a new client" do
+    before do
+      response = double('response', :status=>200, :body => {"_links" => [{"self" => "/"}, {"horse" => "/horses/new"}, {"rabbits" => "/rabbits"}]})
+      @raw_connection = double('raw_connection', :get => response)
+      @connection = TMS::Connection.stub(:new).and_return(double('connection', :connection => @raw_connection))
+      @client = TMS::Client.new('username', 'password', :api_root => 'null_url')
+    end
+    it 'should discover endpoints for known services' do
+      @client.horse.should be_kind_of(TMS::Horse)
+      @client.rabbits.should be_kind_of(TMS::Rabbits)
+    end
+    it 'should handle 4xx responses' do
+      @raw_connection.stub(:get).and_return(double('response', :status => 404, :body => {'message' => 'hi'}))
+      expect { @client.get('/blargh') }.to raise_error(TMS::Request::Error)
+    end
+    it 'should handle 202 responses' do
+      @raw_connection.stub(:get).and_return(double('response', :status => 202, :body => {'message' => 'hi'}))
+      expect { @client.get('/blargh') }.to raise_error(TMS::Request::InProgress)
+    end
+  end
+
+
+end

data/spec/command_types_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe TMS::CommandTypes do
+  context "loading command types" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @command_types = TMS::CommandTypes.new(client, '/command_types')
+    end
+    it 'should GET ok' do
+      body = [{"fields"=>["dcm_account_codes"], "name"=>"dcm_unsubscribe"}, 
+              {"fields"=>["dcm_account_code", "dcm_topic_codes"], "name"=>"dcm_subscribe"}, 
+              {"fields"=>["http_method", "username", "password", "url"], "name"=>"forward"}] 
+      @command_types.client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {}))
+      @command_types.get
+      @command_types.collection.length.should == 3
+    end
+  end
+end

data/spec/inbound_messages_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe TMS::InboundMessages do
+  context "creating a new inbound messages list" do
+    let(:client) do
+      double('client')
+    end
+    before do
+      @messages = TMS::InboundMessages.new(client, '/inbound_messages')
+    end
+    it 'should GET itself' do
+      body = [{:body=>"HELP", :from=>"+16125551212", :created_at=>"a while ago", :to=>"(651) 433-6258"}, {:body=>"STOP", :from=>"+16125551212", :created_at=>"a while ago", :to=>"(651) 433-6258"}]
+      @messages.client.should_receive(:get).and_return(double('response', :body => body, :status => 200, :headers => {}))
+
+      @messages.get
+      @messages.collection.length.should == 2
+    end
+  end
+end

data/spec/keyword_spec.rb

@@ -0,0 +1,58 @@
+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'})
+    end
+    it 'should initialize with attrs' do
+      @keyword.name.should == 'LOL'
+    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'
+    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.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'}
+      @keyword.client.should_receive('get').with(@keyword.href).and_return(double('response', :status => 200, :body => response))
+      @keyword.get
+      @keyword.name.should == 'FOO'
+    end
+    it 'should PUT cleanly' do
+      @keyword.name = "GOVLIE"
+      response  = {:name => 'govlie'}
+      @keyword.client.should_receive('put').with(@keyword).and_return(double('response', :status => 200, :body => response))
+      @keyword.put
+      @keyword.name.should == 'govlie'
+
+    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/message_spec.rb

@@ -0,0 +1,55 @@
+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'}], :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
+    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/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,30 @@
+$: << File.expand_path("../lib", __FILE__)
+require 'tms_client'
+
+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
+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_client_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

data/tms_client.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "tms_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tms_client"
+  s.version     = 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, to interact with GovDelivery's TMS API. The client is compatible with Ruby versions 1.8.7 and 1.9.3. }
+
+  if RUBY_VERSION < "1.9"
+    s.add_runtime_dependency "json" # this is part of 1.9's stdlib
+  end
+  
+  s.add_runtime_dependency "faraday"
+  s.add_runtime_dependency "faraday_middleware"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "link_header"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rubygems-tasks"
+
+  s.files       = %w{
+    Gemfile
+    README.md
+    Rakefile
+    tms_client.gemspec
+  } + Dir["lib/**/*"]
+
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: tms_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- GovDelivery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: link_header
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A reference implementation, written in Ruby, to interact with GovDelivery''s
+  TMS API. The client is compatible with Ruby versions 1.8.7 and 1.9.3. '
+email:
+- support@govdelivery.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- tms_client.gemspec
+- lib/tms_client/base.rb
+- lib/tms_client/client.rb
+- lib/tms_client/collection_resource.rb
+- lib/tms_client/connection.rb
+- lib/tms_client/instance_resource.rb
+- lib/tms_client/logger.rb
+- lib/tms_client/request.rb
+- lib/tms_client/resource/collections.rb
+- lib/tms_client/resource/command.rb
+- lib/tms_client/resource/command_type.rb
+- lib/tms_client/resource/commands.rb
+- lib/tms_client/resource/email.rb
+- lib/tms_client/resource/email_recipient.rb
+- lib/tms_client/resource/inbound_message.rb
+- lib/tms_client/resource/keyword.rb
+- lib/tms_client/resource/recipient.rb
+- lib/tms_client/resource/sms_message.rb
+- lib/tms_client/resource/voice_message.rb
+- lib/tms_client/util/core_ext.rb
+- lib/tms_client/util/hal_link_parser.rb
+- lib/tms_client/version.rb
+- lib/tms_client.rb
+- spec/client_spec.rb
+- spec/command_types_spec.rb
+- spec/inbound_messages_spec.rb
+- spec/keyword_spec.rb
+- spec/keywords_spec.rb
+- spec/message_spec.rb
+- spec/messages_spec.rb
+- spec/spec_helper.rb
+- spec/tms_client_spec.rb
+homepage: http://govdelivery.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 335366191
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 335366191
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby client to interact with the GovDelivery TMS REST API.
+test_files:
+- spec/client_spec.rb
+- spec/command_types_spec.rb
+- spec/inbound_messages_spec.rb
+- spec/keyword_spec.rb
+- spec/keywords_spec.rb
+- spec/message_spec.rb
+- spec/messages_spec.rb
+- spec/spec_helper.rb
+- spec/tms_client_spec.rb