phaxion 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+

data/.ruby-gemset

@@ -0,0 +1 @@
+phaxion

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p374

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in phaxion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 bjh
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Phaxion
+
+**pronounced like Faction**  
+
+A (hopefully) small wrapper around the [Phaxio API](https://www.phaxio.com/docs).  
+
+I made it to be flexible regarding what Phaxio API methods can be called.  
+You can use camel case `sexyMethodCall` or be more Ruby-esque `sexy_method_call` and the gem figures it out for you.
+
+**NOTE:** I have borrowed gratuitously from [this phaxio gem](https://github.com/gristmill/phaxio) so all credit should probably go to that author.
+The reason I wrote this was because the aforementioned gem author hardcoded the available methods you could call on the Phaxio API. 
+This cut out PhaxCodes and some other fun things.
+
+**ANOTHER NOTE:** let's be honest, almost every single gemified API wrapper is a messy wrapper around HttParty. *Now that is one useful gem.*  
+
+The only real win here is managing the API keys...you can actually call all the Phaxio
+API methods using this gem like so: `Phaxion.direct(:phaxio_api_method, arg1:123, arg2:'magic')`, the rest of this gem is fluff. I should have named it fluffy...dammit!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'phaxion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install phaxion
+
+## Usage
+
+**note:** Phaxio uses `send` as the name of a method which conflicts with Ruby so I have mapped it to `fax`. This is the only method name I have changed. I did not want to mess around with aliasing and other *meta*.
+
+  ```ruby
+  # initialize with your keys
+  Phaxion.api_keys = '7d7f87d7f8d78f7'
+  Phaxion.api_secret = '999dfdf33f3f'
+  
+  # OR
+  Phaxion.configuration do |cfg|
+    cfg.api_key = "8udf8duf8duf"
+  	cfg.api_secret = "34jhdf873jh"
+  end
+  
+  # enjoy the magic
+  Phaxion.fax(to: '555-123-1234' string_data:"hello there fax people!")
+  
+  # you are mad at me cause I was lazy and did not wrap one of the Phaxio API methods...
+  # just call it directly
+  Phaxion.direct(:send, to: '555-123-1234' string_data:"hello there fax people!")
+  
+  # use camelCase OR Ruby style api names
+  Phaxion.test_receive == Phaxion.testReceive
+  ```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r phaxion.rb"
+end

data/lib/phaxion/api.rb

@@ -0,0 +1,5 @@
+#module Phaxion
+  #module API
+
+  #end
+#end

data/lib/phaxion/configuration.rb

@@ -0,0 +1,5 @@
+# module Phaxion
+#   module Configuration
+#     attr_accessor :api_key, :api_secret
+#   end
+# end

data/lib/phaxion/dto/fax.rb

@@ -0,0 +1,21 @@
+module Phaxion
+  module DTO
+    class Fax < Struct.new(
+      :id,
+      :direction,
+      :num_pages,
+      :cost,
+      :status,
+      :is_test,
+      :requested_at,
+      # not always present
+      :from_number,
+      :to_number,
+      :recipients,
+      :error_type,
+      :error_code,
+      :completed_at
+    )
+    end
+  end
+end

data/lib/phaxion/dto/phone_number.rb

@@ -0,0 +1,6 @@
+module Phaxion
+  module DTO
+    class PhoneNumber < Struct.new(:number, :city, :state, :cost, :last_billed_at, :provisioned_at)
+    end
+  end
+end

data/lib/phaxion/dto/recipient.rb

@@ -0,0 +1,6 @@
+module Phaxion
+  module DTO
+    class Recipient < Struct.new(:number, :status, :completed_at)
+    end
+  end
+end

data/lib/phaxion/mapper.rb

@@ -0,0 +1,4 @@
+#module Phaxion
+  #module Mapper
+  #end
+#end

data/lib/phaxion/phaxion.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'active_support/core_ext/string'
+
+module Phaxion
+    include HTTMultiParty
+
+    @@api_url = 'https://api.phaxio.com/v1'
+
+    def self.url(api_method)
+      "#{@@api_url}/#{api_method.to_s}"
+    end
+
+    def self.renamer(method)
+      method.to_s.camelize(:lower)
+    end
+
+    def self.method_missing(method, *args, &block)
+      if method.to_sym == :fax
+        method = :send
+      end
+
+      method = renamer(method)
+      post(url(method), query: Hash[*args].merge({api_key: api_key, api_secret: api_secret}))
+    end
+
+    def self.direct(method, *args)
+      post(url(renamer(method)), query: Hash[*args].merge({api_key: api_key, api_secret: api_secret}))
+    end
+
+    def self.configuration
+      yield(self) if block_given?
+    end
+
+    module Configuration
+      attr_accessor :api_key, :api_secret
+    end
+
+    extend Configuration
+end

data/lib/phaxion/version.rb

@@ -0,0 +1,3 @@
+module Phaxion
+  VERSION = "0.0.1"
+end

data/lib/phaxion.rb

@@ -0,0 +1,3 @@
+require "httmultiparty"
+require "phaxion/version"
+require "phaxion/phaxion"

data/phaxion.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'phaxion/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "phaxion"
+  gem.version       = Phaxion::VERSION
+  gem.authors       = ["bjh"]
+  gem.email         = ["bjh@fake.fake"]
+  gem.description   = %q{giving the Phaxio API a nice big hug.}
+  gem.summary       = %q{Phaxio API wrapper}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "httmultiparty"
+  gem.add_runtime_dependency "active_support"
+  gem.add_runtime_dependency "i18n"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "fakeweb"
+end

data/spec/phaxion_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+# require 'json'
+require_relative '../lib/phaxion'
+
+describe Phaxion do
+  before :all do
+    Phaxion.configuration do |cfg|
+      cfg.api_key = "8udf8duf8duf"
+      cfg.api_secret = "34jhdf873jh"
+    end
+  end
+
+  describe ".fax" do
+    it "calls the Phaxio :send method" do
+      response = Phaxion.fax(to: '555-123-1234')
+      expect(response["success"]).to be_true
+      expect(response["message"]).to eq "Fax queued for sending"
+    end
+  end
+
+  describe ".direct" do
+    context "you can call anything with direct" do
+      it "posts the method to the Phaxio API" do
+        response = Phaxion.direct(:send, to: '555-123-1234')
+        expect(response["success"]).to be_true
+      end
+
+      it "translates the given api method to the expected camelCase version" do
+        response = Phaxion.direct(:test_receive, to: '555-123-1234')
+        expect(response["success"]).to be_true
+      end
+    end
+  end
+
+  describe "calling methods using camelCase or under_score syntax" do
+    it "accepts test_receive" do
+      expect(Phaxion.renamer(:test_receive)).to eq "testReceive"
+    end
+
+    it "accepts testReceive" do
+      expect(Phaxion.renamer(:testReceive)).to eq "testReceive"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# 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.
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each do |f|
+  # puts "requiring #{f}"
+  require f
+end
+
+# 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'
+
+  config.before(:each) do
+    # FakeWeb.clean_registry
+  end
+end

data/spec/support/fakeweb_urls.rb

@@ -0,0 +1,23 @@
+
+module Fake
+  @@base_url = "https://api.phaxio.com/v1"
+  @@base_response_dir = "#{File.dirname(__FILE__)}/responses"
+
+  def self.body(response)
+    File.open(File.join(@@base_response_dir, "#{response.to_s}.json")).read
+  end
+
+  def self.content_type
+    "application/json"
+  end
+
+  def self.register(action)
+    FakeWeb.register_uri(:post, "#{@@base_url}/#{action.to_s}", body:body(action), content_type:content_type)
+  end
+end
+
+# load all the fakeweb responses and register them by name/API call
+Dir[File.dirname(__FILE__) + "/responses/*.json"].each do |file| 
+  Fake.register(File.basename(file, ".*" ))
+end
+

data/spec/support/responses/accountStatus.json

@@ -0,0 +1,9 @@
+{
+    "success":true,
+    "message":"Account status retrieved successfully",
+    "data":{
+        "faxes_sent_this_month":120,
+        "faxes_sent_today":10,
+        "balance":3000
+    }
+}

data/spec/support/responses/cancel.json

@@ -0,0 +1,4 @@
+{
+    "success":true,
+    "message":"Fax canceled successfully."
+}

data/spec/support/responses/faxStatus.json

@@ -0,0 +1,21 @@
+{
+    "success":true,
+    "message":"Retrieved fax successfully",
+    "data":{
+        "id":123456,
+        "num_pages":3,
+        "cost":21,
+        "direction":"sent",
+        "status":"success",
+        "is_test":true,
+        "requested_at":1293910680,
+        "completed_at":1293911100,
+        "recipients":[
+{
+                "number":"4141234567",
+                "status":"success",
+                "completed_at":1293911100
+            }
+        ]
+    }
+}

data/spec/support/responses/listFaxes.json

@@ -0,0 +1,68 @@
+{
+    "success":true,
+    "message":"Retrieved faxes successfully",
+    "paging":{
+        "max_per_page":1000,
+        "page":1,
+        "total_pages":1,
+        "total_results":3
+    },
+    "data":[
+{
+            "id":123456,
+            "num_pages":3,
+            "cost":21,
+            "direction":"sent",
+            "status":"success",
+            "is_test":true,
+            "requested_at":1293910680,
+            "completed_at":1293911100,
+            "recipients":[
+{
+                    "number":"4141234567",
+                    "status":"success",
+                    "completed_at":1293911100
+                }
+            ]
+        },
+{
+            "id":123457,
+            "num_pages":1,
+            "cost":7,
+            "direction":"sent",
+            "status":"success",
+            "is_test":false,
+            "requested_at":1293984720,
+            "completed_at":1293985800,
+            "recipients":[
+{
+                    "number":"4145554567",
+                    "status":"success",
+                    "completed_at":1293985800
+                }
+            ]
+        },
+{
+            "id":123458,
+            "num_pages":1,
+            "cost":14,
+            "direction":"sent",
+            "status":"success",
+            "is_test":false,
+            "requested_at":1294094700,
+            "completed_at":1294095000,
+            "recipients":[
+{
+                    "number":"4145554568",
+                    "status":"success",
+                    "completed_at":1294095000
+                },
+{
+                    "number":"4145554567",
+                    "status":"success",
+                    "completed_at":1293985800
+                }
+            ]
+        }
+    ]
+}

data/spec/support/responses/numberList.json

@@ -0,0 +1,22 @@
+{
+    "success":true,
+    "message":"Retrieved user phone numbers successfully",
+    "data":[
+{
+            "number":"8021112222",
+            "city":"Burlington",
+            "state":"Vermont",
+            "cost":200,
+            "last_billed_at":"2012-10-11 10:51:33",
+            "provisioned_at":"2012-10-11 10:51:33"
+        },
+{
+            "number":"8023334444",
+            "city":"Montpelier",
+            "state":"Vermont",
+            "cost":200,
+            "last_billed_at":"2012-10-11 10:51:33",
+            "provisioned_at":"2012-10-11 10:51:33"
+        }
+    ]
+}

data/spec/support/responses/provisionNumber.json

@@ -0,0 +1,12 @@
+{
+    "success":true,
+    "message":"Number provisioned successfully!",
+    "data":{
+        "number":"8021112222",
+        "city":"Burlington",
+        "state":"Vermont",
+        "cost":200,
+        "last_billed_at":"2012-10-11 10:00:44",
+        "provisioned_at":"2012-10-11 10:00:44"
+    }
+}

data/spec/support/responses/releaseNumber.json

@@ -0,0 +1,7 @@
+{
+    "success":true,
+    "message":"Number released successfully!",
+    "data":[
+
+    ]
+}

data/spec/support/responses/send.json

@@ -0,0 +1,8 @@
+{
+    "success":true,
+    "message":"Fax queued for sending",
+    "faxId":1234,
+    "data":{
+        "faxId":1234
+    }
+}

data/spec/support/responses/sendFailure.json

@@ -0,0 +1,8 @@
+{
+    "success":false,
+    "message":"Fax not queued for sending",
+    "faxId":1234,
+    "data":{
+        "faxId":1234
+    }
+}

data/spec/support/responses/testReceive.json

@@ -0,0 +1,4 @@
+{
+    "success":true,
+    "message":"Test fax received from 234567890. Calling back now..."
+}

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: phaxion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- bjh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httmultiparty
+  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: active_support
+  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: i18n
+  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: fakeweb
+  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: giving the Phaxio API a nice big hug.
+email:
+- bjh@fake.fake
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/phaxion.rb
+- lib/phaxion/api.rb
+- lib/phaxion/configuration.rb
+- lib/phaxion/dto/fax.rb
+- lib/phaxion/dto/phone_number.rb
+- lib/phaxion/dto/recipient.rb
+- lib/phaxion/mapper.rb
+- lib/phaxion/phaxion.rb
+- lib/phaxion/version.rb
+- phaxion.gemspec
+- spec/phaxion_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeweb_urls.rb
+- spec/support/responses/accountStatus.json
+- spec/support/responses/cancel.json
+- spec/support/responses/faxStatus.json
+- spec/support/responses/listFaxes.json
+- spec/support/responses/numberList.json
+- spec/support/responses/provisionNumber.json
+- spec/support/responses/releaseNumber.json
+- spec/support/responses/send.json
+- spec/support/responses/sendFailure.json
+- spec/support/responses/testReceive.json
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Phaxio API wrapper
+test_files:
+- spec/phaxion_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakeweb_urls.rb
+- spec/support/responses/accountStatus.json
+- spec/support/responses/cancel.json
+- spec/support/responses/faxStatus.json
+- spec/support/responses/listFaxes.json
+- spec/support/responses/numberList.json
+- spec/support/responses/provisionNumber.json
+- spec/support/responses/releaseNumber.json
+- spec/support/responses/send.json
+- spec/support/responses/sendFailure.json
+- spec/support/responses/testReceive.json