pamfaxr 0.0.1 → 0.0.2

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2010 Voxeo Corporation
+Copyright (c) 2011 Voxeo Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,12 +1,12 @@
 PamFaxr
 =======
 
-Ruby library for sending faxes via the [PamFax](http://pamfax.com) Simple API.
+Ruby library for sending faxes via the [PamFax](http://www.pamfax.biz/en/partners/tropo/) Simple API.
 
 Overview
 --------
 
-You may send faxes using the PamFax API. See the [PamFax Developer](http://www.pamfax.biz/en/extensions/developers/) page for more details and how to get your developer key.
+You may send faxes using the PamFax API. See the [PamFax Developer](http://www.pamfax.biz/en/partners/tropo/) page for more details and how to get your developer key.
 
 Requirements
 ------------
@@ -20,26 +20,30 @@ Example
 -------
 
     # Create a new PamFaxr object
-	pamfaxr = PamFaxr.new :base_uri => 'https://sandbox-api.pamfax.biz',
-	                      :key      => 'your_api_key', 
-	                      :secret   => 'your_api_secret', 
-	                      :username => 'your_username', 
+	
+	pamfaxr = PamFaxr.new :username => 'your_username', 
 	                      :password => 'your_password'
+	
 	# Create a new FaxJob
 	pamfaxr.create_fax_job
+    
     # Add the cover sheet
 	covers = pamfaxr.list_available_covers
 	pamfaxr.set_cover(covers['Covers']['content'][1]['id'], 'Foobar is here!')
+	
 	# Add files
-	pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/R-intro.pdf')
-	pamfaxr.add_file('examples/R-intro.pdf')
+	pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/Tropo.pdf')
+	pamfaxr.add_file('examples/Tropo.pdf')
+	
 	# Add a recipient
 	pamfaxr.add_recipient('+14155551212')
+	
 	# Loop until the fax is ready to send
 	loop do
 	  fax_state = pamfaxr.get_state
 	  break if fax_state['FaxContainer']['state'] == 'ready_to_send'
 	  sleep 5
 	end
+	
 	# Send the fax
 	pamfaxr.send_fax

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/examples/example.rb

@@ -2,15 +2,12 @@ require 'rubygems'
 require 'lib/pamfaxr'
 require 'awesome_print'
 
-PAMFAX_URI      = 'https://sandbox-api.pamfax.biz'
-PAMFAX_KEY      = 'your_key'
-PAMFAX_SECRET   = 'your_secret'
-PAMFAX_USERNAME = 'your_username'
-PAMFAX_PASSWORD = 'your_password'
+PAMFAX_URI      = 'https://api.pamfax.biz/'
+PAMFAX_USERNAME = 'username'
+PAMFAX_PASSWORD = 'password'
 
+# You may also specificy a custom :api_key and :api_secret, or it uses the default
 pamfaxr = PamFaxr.new :base_uri => PAMFAX_URI,
-                      :key      => PAMFAX_KEY, 
-                      :secret   => PAMFAX_SECRET, 
                       :username => PAMFAX_USERNAME, 
                       :password => PAMFAX_PASSWORD
 
@@ -31,11 +28,11 @@ ap pamfaxr.set_cover(covers['Covers']['content'][1]['id'], 'Foobar is here!')
 
 ap 'Adding a remote file'
 ap '*'*10
-ap pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/R-intro.pdf')
+ap pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/Tropo.pdf')
 
 ap 'Adding a local file'
 ap '*'*10
-file = pamfaxr.add_file('examples/R-intro.pdf')
+file = pamfaxr.add_file('examples/Tropo.pdf')
 ap file
 
 ap 'Removing a file'

data/lib/pamfaxr/pamfaxr.rb

@@ -1,6 +1,6 @@
 class PamFaxr
   class FaxJob
-    require 'awesome_print'
+
     ##
     # Instantiates the FaxJob class
     #
@@ -133,7 +133,7 @@ class PamFaxr
     # @return [Hash] the result of the request to add a file
     #
     # @example adding a remote file
-    #   pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/R-intro.pdf')
+    #   pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/Tropo.pdf')
     #
     #   returns:
     #
@@ -144,7 +144,7 @@ class PamFaxr
     #         "message" => ""
     #     },
     #     "FaxContainerFile" => {
-    #               "name" => "R-intro.pdf",
+    #               "name" => "Tropo.pdf",
     #         "file_order" => 0,
     #                "ext" => "pdf",
     #          "file_uuid" => "CwPx31xjl9k7Cp",
@@ -288,7 +288,7 @@ class PamFaxr
     #            "type" => "list",
     #         "content" => [
     #             [0] {
-    #                       "name" => "R-intro.pdf",
+    #                       "name" => "Tropo.pdf",
     #                       "size" => 646768,
     #                  "extension" => "pdf",
     #                       "uuid" => "CwPx31xjl9k7Cp",
@@ -699,7 +699,8 @@ class PamFaxr
     # @return [Hash] the result of the request
     def get(resource)
       begin
-        JSON.parse @http.get(resource, { 'Content-Type' => 'application/json' }).body
+        body = @http.get(resource, { 'Content-Type' => 'application/json' }).body
+        JSON.parse body
       rescue => error
       end
     end
@@ -725,21 +726,23 @@ class PamFaxr
   # Creates an instance of the PamFax class
   #
   # @param [Hash] params the options for instantiating a PamFax class
-  # @option params [optionsl, String] :base_uri the URI of the PamFax API, it defaults to https://api.pamfax.biz
-  # @option params [String] :key the PamFax API key you have been assigned
-  # @option params [String] :secret the PamFax API secret you have been assigned
   # @option params [String] :username the PamFax username you are going to use to send faxes
   # @option params [String] :password the PamFax password you are going to use to send faxes
+  # @option params [optionsl, String] :base_uri the URI of the PamFax API, it defaults to https://api.pamfax.biz
+  # @option params [optional, String] :api_key the PamFax API key you have been assigned
+  # @option params [optional, String] :api_secret the PamFax API secret you have been assigned
   #
   # @return [Object] the instantiated FaxJob class
   #
   # @example create a new PamFax object
   #   pamfaxr = PamFax.new({ :key => 'your_api_key', :secret => 'your_api_secret' })
   def initialize(options={})
-    base_uri = options[:base_uri] || "https://api.pamfax.biz"
+    base_uri   = options[:base_uri]   || "https://api.pamfax.biz"
+    api_key    = options[:api_key]    || "tropo_developer"
+    api_secret = options[:api_secret] || "7xGi0xAqcg3YXw"
     
     options.merge!({ :http            => create_http(URI.parse(base_uri)),
-                     :api_credentials => "?apikey=#{options[:key]}&apisecret=#{options[:secret]}&apioutputformat=API_FORMAT_JSON" })
+                     :api_credentials => "?apikey=#{api_key}&apisecret=#{api_secret}&apioutputformat=API_FORMAT_JSON" })
     options[:api_credentials] = options[:api_credentials] + "&usertoken=#{get_user_token(options)}"
     
     @fax_job = FaxJob.new options
@@ -782,7 +785,8 @@ class PamFaxr
   # @return [Object] the instantiated FaxJob class
   def verify_user(options={})
     resource = "/Session/VerifyUser/#{options[:api_credentials]}&username=#{options[:username]}&password=#{options[:password]}"
-    JSON.parse options[:http].get(resource).body 
+    body = options[:http].get(resource).body 
+    JSON.parse body
   end
   
   ##

data/pamfaxr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pamfaxr}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Goecke"]
-  s.date = %q{2011-01-26}
+  s.date = %q{2011-02-10}
   s.description = %q{Ruby library for the FaxJob portion of the PamFax API.}
   s.email = %q{jsgoecke@voxeo.com}
   s.extra_rdoc_files = [
@@ -17,15 +17,13 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".bundle/config",
-    ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE",
     "README.md",
     "Rakefile",
     "VERSION",
-    "examples/R-intro.pdf",
+    "examples/Tropo.pdf",
     "examples/example.rb",
     "lib/pamfaxr.rb",
     "lib/pamfaxr/multipart.rb",
@@ -39,7 +37,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/tropo/pamfaxr}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby library for the PamFax API.}
   s.test_files = [
     "examples/example.rb",
@@ -51,7 +49,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mime-types>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])

data/spec/pamfaxr_spec.rb

@@ -1,10 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-PAMFAX_URI      = 'https://sandbox-api.pamfax.biz'
-PAMFAX_KEY      = 'name'
-PAMFAX_SECRET   = 'abd123'
-PAMFAX_USERNAME = 'fooey'
-PAMFAX_PASSWORD = 'foobar'
+PAMFAX_URI        = 'https://sandbox-api.pamfax.biz'
+PAMFAX_API_KEY    = 'name'
+PAMFAX_API_SECRET = 'abd123'
+PAMFAX_USERNAME   = 'fooey'
+PAMFAX_PASSWORD   = 'foobar'
 
 FakeWeb.allow_net_connect = false
 
@@ -178,7 +178,7 @@ describe "PamFaxr" do
                       "message" => ""
                   },
                   "FaxContainerFile" => {
-                            "name" => "R-intro.pdf",
+                            "name" => "Tropo.pdf",
                       "file_order" => 0,
                              "ext" => "pdf",
                        "file_uuid" => "OQskZYr9D0MANw",
@@ -194,7 +194,7 @@ describe "PamFaxr" do
                                   "message" => ""
                               },
                               "FaxContainerFile" => {
-                                        "name" => "R-intro.pdf",
+                                        "name" => "Tropo.pdf",
                                   "file_order" => 0,
                                          "ext" => "pdf",
                                    "file_uuid" => "OuH2JbbGKhDp8o",
@@ -221,7 +221,7 @@ describe "PamFaxr" do
                              "type" => "list",
                           "content" => [
                                   {
-                                        "name" => "R-intro.pdf",
+                                        "name" => "Tropo.pdf",
                                         "size" => 646768,
                                    "extension" => "pdf",
                                         "uuid" => "aMzeebWS9O8GKz",
@@ -231,7 +231,7 @@ describe "PamFaxr" do
                                      "created" => "2011-01-17 14:55:57"
                               },
                                   {
-                                        "name" => "examples/R-intro.pdf",
+                                        "name" => "examples/Tropo.pdf",
                                         "size" => 646768,
                                    "extension" => "pdf",
                                         "uuid" => "BVMJzRmu1zAlSZ",
@@ -308,9 +308,13 @@ describe "PamFaxr" do
                         }
                     }
 
-    # Addresses
     FakeWeb.register_uri(:get, 
-                         "https://sandbox-api.pamfax.biz/Session/VerifyUser/?apikey=#{PAMFAX_KEY}&apisecret=#{PAMFAX_SECRET}&apioutputformat=API_FORMAT_JSON&username=#{PAMFAX_USERNAME}&password=#{PAMFAX_PASSWORD}", 
+                         "https://sandbox-api.pamfax.biz/Session/VerifyUser/?apikey=#{PAMFAX_API_KEY}&apisecret=#{PAMFAX_API_SECRET}&apioutputformat=API_FORMAT_JSON&username=#{PAMFAX_USERNAME}&password=#{PAMFAX_PASSWORD}", 
+                         :body => @user_found.to_json, 
+                         :content_type => "application/json")
+
+    FakeWeb.register_uri(:get, 
+                         "https://api.pamfax.biz/Session/VerifyUser/?apikey=tropo_developer&apisecret=7xGi0xAqcg3YXw&apioutputformat=API_FORMAT_JSON&username=fooey&password=looey", 
                          :body => @user_found.to_json, 
                          :content_type => "application/json")
 
@@ -357,7 +361,7 @@ describe "PamFaxr" do
                          :status => ["200", "OK"])
 
    FakeWeb.register_uri(:get, 
-                        "https://sandbox-api.pamfax.biz/FaxJob/AddRemoteFile?apikey=name&apisecret=abd123&apioutputformat=API_FORMAT_JSON&usertoken=m3cv0d9gqb69taajcu76nqv5eccht76t&url=https://s3.amazonaws.com/pamfax-test/R-intro.pdf",
+                        "https://sandbox-api.pamfax.biz/FaxJob/AddRemoteFile?apikey=name&apisecret=abd123&apioutputformat=API_FORMAT_JSON&usertoken=m3cv0d9gqb69taajcu76nqv5eccht76t&url=https://s3.amazonaws.com/pamfax-test/Tropo.pdf",
                         :body => @page.to_json,
                         :content_type => "application/json",
                         :status => ["200", "OK"])
@@ -399,11 +403,11 @@ describe "PamFaxr" do
                           :status => ["200", "OK"])
                                                                           
     # Our testing URI
-    @pamfaxr = PamFaxr.new :base_uri => PAMFAX_URI,
-                           :key      => PAMFAX_KEY, 
-                           :secret   => PAMFAX_SECRET, 
-                           :username => PAMFAX_USERNAME, 
-                           :password => PAMFAX_PASSWORD
+    @pamfaxr = PamFaxr.new :base_uri     => PAMFAX_URI,
+                           :api_key      => PAMFAX_API_KEY, 
+                           :api_secret   => PAMFAX_API_SECRET, 
+                           :username     => PAMFAX_USERNAME, 
+                           :password     => PAMFAX_PASSWORD
 
   end
   
@@ -411,13 +415,19 @@ describe "PamFaxr" do
     @pamfaxr.instance_of?(PamFaxr).should == true
   end
   
+  it "should create an instance of PamFax without the base_uri, api_key or api_secret included" do
+    pamfaxr = PamFaxr.new :username     => 'fooey', 
+                          :password     => 'looey'
+    pamfaxr.instance_of?(PamFaxr).should == true
+  end
+  
   it "should get an error if invalid user details are requested" do
     begin
-      pamfax = PamFaxr.new :base_uri => PAMFAX_URI,
-                           :key      => 'tropo', 
-                           :secret   => 'abc123', 
-                           :username => 'fooey', 
-                           :password => 'looey'
+      pamfax = PamFaxr.new :base_uri     => PAMFAX_URI,
+                           :api_key      => 'tropo', 
+                           :api_secret   => 'abc123', 
+                           :username     => 'fooey', 
+                           :password     => 'looey'
     rescue => e
       e.to_s.should == "Unknown user name or incorrect password"
     end
@@ -452,8 +462,8 @@ describe "PamFaxr" do
   end
   
   it "should add a file to the fax job" do
-    @pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/R-intro.pdf').should == @page
-    @pamfaxr.add_file('examples/R-intro.pdf').should == @local_file_upload
+    @pamfaxr.add_remote_file('https://s3.amazonaws.com/pamfax-test/Tropo.pdf').should == @page
+    @pamfaxr.add_file('examples/Tropo.pdf').should == @local_file_upload
   end
   
   it "should list the available fax cover templates" do

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: pamfaxr
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jason Goecke
@@ -15,99 +14,87 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 -08:00
+date: 2011-02-10 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
   name: mime-types
   version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   requirement: *id001
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :runtime
-  prerelease: false
   name: json
   version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   requirement: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
   name: rspec
   version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 2
         - 3
         - 0
         version: 2.3.0
   requirement: *id003
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
   name: bundler
   version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
   requirement: *id004
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
   name: jeweler
   version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 5
         - 2
         version: 1.5.2
   requirement: *id005
+  prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
   name: rcov
   version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   requirement: *id006
+  prerelease: false
 description: Ruby library for the FaxJob portion of the PamFax API.
 email: jsgoecke@voxeo.com
 executables: []
@@ -118,15 +105,13 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
-- .bundle/config
-- .document
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
-- examples/R-intro.pdf
+- examples/Tropo.pdf
 - examples/example.rb
 - lib/pamfaxr.rb
 - lib/pamfaxr/multipart.rb
@@ -146,27 +131,23 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby library for the PamFax API.

data/.bundle/config

@@ -1,2 +0,0 @@
---- 
-BUNDLE_DISABLE_SHARED_GEMS: "1"

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE