hello_fax 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,19 @@
+# HelloFax API
+
+Register on [https://www.hellofax.com](https://www.hellofax.com) to obtain an account and GUID.
+
+Due to an [outstanding issue](https://github.com/jwagener/httmultiparty/issues/10) with HTTMultiParty we can only send one document at a time.
+
+HelloFax developer is allowing 10 files per request.
+> I'm thinking that I'll limit the number of files to 10 and the total upload size to 30 MB and give an immediate, synchronous error for both these cases. I'll also limit faxes to a total of 200 pages and return an error in the callback (since I can't determine number of pages quickly enough to give a synchronous error).
+
+The API documentation is not exposed anywhere but this wrapper consists of all the functionality the API has.
+
+There are the two callback URLs, one for inbound and one for outbound, that can be set through `update_account_details`.
+
+Then all you need to do is:
+
+```
+$hello_fax = HelloFax::API.new("email@address.com", 'password', 'guid') # this belongs in an initializer
+$hello_fax.send_fax('5555555555', File.new("file.pdf")).parsed_response
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/hello_fax.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hello_fax/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hello_fax"
+  s.version     = HelloFax::VERSION
+  s.authors     = ["Ellis Berner"]
+  s.email       = ["eberner@doximity.com"]
+  s.homepage    = "https://github.com/maletor/hello_fax"
+  s.summary     = %q{wrapper for HelloFax api}
+  s.description = %q{Uses HTTMultiParty for interfacing with HelloFax to send and receive faxes, buy fax lines and more.}
+
+  s.rubyforge_project = "hello_fax"
+
+  s.files         = `git ls-files`.split("\n")
+  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"]
+
+  s.add_dependency "httmultiparty", "~> 0.3.5"
+
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+end

data/lib/hello_fax.rb

@@ -0,0 +1,44 @@
+require "hello_fax/version"
+require "httmultiparty"
+
+module HelloFax
+  class API
+
+    include ::HTTMultiParty
+
+    base_uri "https://www.hellofax.com/apiapp.php/v1/"
+    headers 'User-Agent' => "hello_fax gem #{VERSION}"
+
+    attr_accessor :guid
+
+    def initialize(username, password, guid)
+      self.class.basic_auth username, password
+      @guid = guid
+    end
+
+    def send_fax(to, file)
+      self.class.post("/Accounts/#{@guid}/Transmissions", :query => { :To => to, :file => file })
+    end
+
+    def account_details
+      self.class.get("/Accounts/#{@guid}")
+    end
+
+    def update_account_details(options)
+      self.class.put("/Accounts/#{@guid}", :query => options)
+    end
+
+    def transmissions
+      self.class.get("/Accounts/#{@guid}/Transmissions")
+    end
+
+    def fax_lines
+      self.class.get("/Accounts/#{@guid}/FaxLines")
+    end
+
+    def find_fax_numbers(state_code)
+      self.class.get('/AreaCodes', :query => { :StateCode => state_code })
+    end
+
+  end
+end

data/lib/hello_fax/version.rb

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

data/spec/hello_fax_spec.rb

@@ -0,0 +1,8 @@
+describe HelloFax do
+  it "should post a fax"
+  it "should get account details"
+  it "should put account details"
+  it "should get current transmissions"
+  it "should get fax lines in use"
+  it "should get fax numbers available by state"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: hello_fax
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ellis Berner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httmultiparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: Uses HTTMultiParty for interfacing with HelloFax to send and receive faxes, buy fax lines and more.
+email: 
+- eberner@doximity.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- hello_fax.gemspec
+- lib/hello_fax.rb
+- lib/hello_fax/version.rb
+- spec/hello_fax_spec.rb
+homepage: https://github.com/maletor/hello_fax
+licenses: []
+
+post_install_message: 
+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: hello_fax
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: wrapper for HelloFax api
+test_files: 
+- spec/hello_fax_spec.rb