interfax 0.2.1 → 1.0.0.beta.1

data/lib/interfax.rb

@@ -1,9 +1,14 @@
-require 'time'
-require "soap/wsdlDriver"
+require 'interfax/version'
+require 'interfax/client'
+require 'interfax/account'
+require 'interfax/object'
+require 'interfax/file'
+require 'interfax/forwarding_email'
+require 'interfax/outbound'
+require 'interfax/outbound/fax'
+require 'interfax/outbound/delivery'
+require 'interfax/inbound'
+require 'interfax/inbound/fax'
+require 'interfax/image'
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'interfax/fax_item'
-require 'interfax/base'
-require 'interfax/incoming'
+require 'mimemagic'

data/lib/interfax/account.rb

@@ -0,0 +1,10 @@
+class InterFAX::Account
+
+  def initialize client
+    @client = client
+  end
+
+  def balance
+    @client.get('/accounts/self/ppcards/balance').to_f
+  end
+end

data/lib/interfax/client.rb

@@ -0,0 +1,124 @@
+require 'net/https'
+require 'json'
+
+
+module InterFAX
+  class Client
+    class ServerError < StandardError; end
+    class NotFoundError < StandardError; end
+    class BadRequestError < StandardError; end
+    class UnauthorizedError < StandardError; end
+
+    attr_accessor :username, :password, :http
+    attr_writer :outbound, :inbound, :account
+
+    DOMAIN = "rest.interfax.net".freeze
+    USER_AGENT = "InterFAX Ruby #{InterFAX::VERSION}".freeze
+
+    def initialize(options = {})
+      self.username = options.fetch(:username) do
+        ENV['INTERFAX_USERNAME'] || raise(KeyError, "Missing required argument: username")
+      end
+
+      self.password = options.fetch(:password) do
+        ENV['INTERFAX_PASSWORD'] || raise(KeyError, "Missing required argument: password")
+      end
+
+      self.http = Net::HTTP.new(DOMAIN, Net::HTTP.https_default_port)
+      http.set_debug_output $stdout if options[:debug]
+      http.use_ssl = true
+    end
+
+    def account
+      @account ||= InterFAX::Account.new(self)
+    end
+
+    def deliver params = {}
+      outbound.deliver(params)
+    end
+
+    def outbound
+      @outbound ||= InterFAX::Outbound.new(self)
+    end
+
+    def inbound
+      @inbound ||= InterFAX::Inbound.new(self)
+    end
+
+    def get path, params = {}, valid_keys = {}
+      uri = uri_for(path, params, valid_keys)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      transmit(request)
+    end
+
+    def post path, params = {}, valid_keys = {}, headers = {}, body = nil
+      uri = uri_for(path, params, valid_keys)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      headers.each do |key, value|
+        request[key] = value
+      end
+      request.body = body if body
+      transmit(request)
+    end
+
+    private
+
+    def uri_for(path, params = {}, keys = {})
+      params = validate(params, keys)
+      uri = URI("https://#{DOMAIN}#{path}")
+      uri.query = URI.encode_www_form(params)
+      uri
+    end
+
+    def validate params = {}, keys = {}
+      params.each do |key, value|
+        if !keys.include? key.to_sym
+          raise ArgumentError.new("Unexpected argument: #{key} - please make to use camelCase arguments")
+        end
+      end
+      params
+    end
+
+    def transmit(request)
+      request["User-Agent"] = USER_AGENT
+      request.basic_auth username, password
+      parse(http.request(request))
+    end
+
+    def parse response
+      case response
+      when Net::HTTPSuccess
+        if response['location']
+          response['location']
+        elsif json?(response)
+          begin
+            JSON.parse(response.body)
+          rescue JSON::ParserError
+            response.body
+          end
+        else
+          response.body
+        end
+      when Net::HTTPNotFound
+        raise NotFoundError, "Record not found: #{response.body}"
+      when Net::HTTPBadRequest
+        raise BadRequestError, "Bad request (400): #{response.body}"
+      when Net::HTTPUnauthorized
+        raise UnauthorizedError, "Access Denied (401): #{response.body}"
+      else
+        if json?(response)
+          raise ServerError, "HTTP #{response.code}: #{JSON.parse(response.body)}"
+        else
+          raise ServerError, "HTTP #{response.code}: #{response.body}"
+        end
+      end
+    end
+
+    def json?(response)
+      content_type = response['Content-Type']
+      json_header = content_type && content_type.split(';').first == 'text/json'
+      has_body = response.body && response.body.length > 0
+      json_header && has_body
+    end
+  end
+end

data/lib/interfax/file.rb

@@ -0,0 +1,31 @@
+class InterFAX::File
+  attr_accessor :header, :body
+
+  def initialize location, options = {}
+    if options[:mime_type]
+      initialize_binary(location, options[:mime_type])
+    elsif location.start_with?('http://') || location.start_with?('https://')
+      initialize_url(location)
+    else
+      initialize_path(location)
+    end
+  end
+
+  def initialize_binary(data, mime_type)
+    self.header = "Content-Type: #{mime_type}"
+    self.body = data
+  end
+
+  def initialize_url(url)
+    self.header = "Content-Location: #{url}"
+    self.body = nil
+  end
+
+  def initialize_path(path)
+    file = File.open(path)
+    mime_type = MimeMagic.by_magic(file)
+
+    self.header = "Content-Type: #{mime_type}"
+    self.body = File.open(path, 'rb').read
+  end
+end

data/lib/interfax/forwarding_email.rb

@@ -0,0 +1,2 @@
+class InterFAX::ForwardingEmail < InterFAX::Object
+end

data/lib/interfax/image.rb

@@ -0,0 +1,15 @@
+class InterFAX::Image < InterFAX::Object
+  def inspect
+    _data = data
+    self.data = "#{data[0..20]}..."
+    result = super
+    self.data = _data
+    result
+  end
+
+  def save filename
+    File.open(filename, 'wb') do |file|
+      file.write(data)
+    end
+  end
+end

data/lib/interfax/inbound.rb

@@ -0,0 +1,45 @@
+class InterFAX::Inbound
+  def initialize client
+    @client = client
+  end
+
+  def all params = {}
+    valid_keys = [:unreadOnly, :limit, :lastId, :allUsers]
+    @client.get('/inbound/faxes', params, valid_keys).map do |fax|
+      fax[:client] = @client
+      InterFAX::Inbound::Fax.new(fax)
+    end
+  end
+
+  def find id
+    fax = @client.get("/inbound/faxes/#{id}")
+    fax[:client] = @client
+    InterFAX::Inbound::Fax.new(fax)
+  end
+
+  def image fax_id
+    data = @client.get("/inbound/faxes/#{fax_id}/image")
+    InterFAX::Image.new(data: data, client: @client)
+  end
+
+  def mark fax_id, options = {}
+    read = options.fetch(:read, true)
+    valid_keys = [:unread]
+    @client.post("/inbound/faxes/#{fax_id}/mark", {unread: !read}, valid_keys)
+    true
+  end
+
+  def resend fax_id, options = {}
+    options = options.delete_if {|k,v| k != :email }
+    valid_keys = [:email]
+    @client.post("/inbound/faxes/#{fax_id}/resend", options, valid_keys)
+    true
+  end
+
+  def emails fax_id
+    @client.get("/inbound/faxes/#{fax_id}/emails").map do |email|
+      email[:client] = @client
+      InterFAX::ForwardingEmail.new(email)
+    end
+  end
+end

data/lib/interfax/inbound/fax.rb

@@ -0,0 +1,21 @@
+class InterFAX::Inbound::Fax < InterFAX::Object
+  def image
+    client.inbound.image(messageId)
+  end
+
+  def reload
+    client.inbound.find(messageId)
+  end
+
+  def mark status = true
+    client.inbound.mark(messageId, read: status)
+  end
+
+  def resend email = nil
+    client.inbound.resend(messageId, email: email)
+  end
+
+  def emails
+    client.inbound.emails(messageId)
+  end
+end

data/lib/interfax/object.rb

@@ -0,0 +1,15 @@
+class InterFAX::Object < OpenStruct
+  def attributes
+    hash = to_h
+    hash.delete(:client)
+    hash
+  end
+
+  def inspect
+    _client = client
+    self.delete_field('client')
+    result = super
+    self.client = _client
+    result
+  end
+end

data/lib/interfax/outbound.rb

@@ -0,0 +1,58 @@
+class InterFAX::Outbound
+
+  attr_writer :delivery
+
+  def initialize client
+    @client = client
+  end
+
+  def delivery
+    @delivery ||= InterFAX::Outbound::Delivery.new(@client)
+  end
+
+  def deliver params = {}
+    delivery.deliver(params)
+  end
+
+  def all params = {}
+    valid_keys = [:limit, :lastId, :sortOrder, :userId]
+    @client.get('/outbound/faxes', params, valid_keys).map do |fax|
+      fax[:client] = @client
+      InterFAX::Outbound::Fax.new(fax)
+    end
+  end
+
+  def completed *ids
+    params = { ids: [ids].flatten }
+    valid_keys = [:ids]
+    @client.get('/outbound/faxes/completed', params, valid_keys).map do |fax|
+      fax[:client] = @client
+      InterFAX::Outbound::Fax.new(fax)
+    end
+  end
+
+  def find id
+    fax = @client.get("/outbound/faxes/#{id}")
+    fax[:client] = @client
+    InterFAX::Outbound::Fax.new(fax)
+  end
+
+  def image fax_id
+    data = @client.get("/outbound/faxes/#{fax_id}/image")
+    InterFAX::Image.new(data: data, client: @client)
+  end
+
+  def cancel fax_id
+    fax = @client.get("/outbound/faxes/#{fax_id}/cancel")
+    fax[:client] = @client
+    InterFAX::Outbound::Fax.new(fax)
+  end
+
+  def search params = {}
+    valid_keys = [:ids, :reference, :dateFrom, :dateTo, :status, :userId, :faxNumber, :limit, :offset]
+    @client.get('/outbound/search', params, valid_keys).map do |fax|
+      fax[:client] = @client
+      InterFAX::Outbound::Fax.new(fax)
+    end
+  end
+end

data/lib/interfax/outbound/delivery.rb

@@ -0,0 +1,52 @@
+class InterFAX::Outbound::Delivery
+  attr_accessor :client, :params, :files, :fax_number
+
+  VALID_KEYS = [:faxNumber, :contact, :postponeTime, :retriesToPerform, :csid, :pageHeader, :reference, :replyAddress, :pageSize, :fitToPage, :pageOrientation, :resolution, :rendering]
+  BOUNDARY = "43e578690a6d14bf1d776cd55e7d7e29"
+  HEADERS = {
+    "Content-Type" => "multipart/mixed; boundary=#{BOUNDARY}"
+  }.freeze
+
+  def initialize client
+    self.client = client
+  end
+
+  def deliver params
+    params, files = validate_params(params)
+
+    file_objects = generate_file_objects(files)
+    body = body_for(file_objects)
+
+    result = client.post('/outbound/faxes', params, VALID_KEYS, HEADERS, body)
+    InterFAX::Outbound::Fax.new(client: client, id: result.split('/').last)
+  end
+
+  private
+
+  def validate_params params
+    self.fax_number = params[:faxNumber] || raise(ArgumentError.new('Missing argument: faxNumber'))
+    files = [params[:file] || params[:files] || raise(ArgumentError.new('Missing argument: file or files'))].flatten
+
+    params.delete(:fax_number)
+    params.delete(:file)
+    params.delete(:files)
+
+    [params, files]
+  end
+
+  def generate_file_objects files
+    files.map do |file|
+      if file.kind_of?(String)
+        InterFAX::File.new(file)
+      elsif file.kind_of?(InterFAX::File)
+        file
+      end
+    end
+  end
+
+  def body_for(files)
+    files.map do |file|
+      "--#{BOUNDARY}\r\n#{file.header}\r\n\r\n#{file.body}\r\n"
+    end.join + "--#{BOUNDARY}\r\n"
+  end
+end

data/lib/interfax/outbound/fax.rb

@@ -0,0 +1,13 @@
+class InterFAX::Outbound::Fax < InterFAX::Object
+  def image
+    client.outbound.image(id)
+  end
+
+  def cancel
+    client.outbound.cancel(id)
+  end
+
+  def reload
+    client.outbound.find(id)
+  end
+end

data/lib/interfax/version.rb

@@ -0,0 +1,3 @@
+module InterFAX
+  VERSION = '1.0.0.beta.1'
+end

metadata

@@ -1,94 +1,132 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: interfax
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 1
-  version: 0.2.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta.1
 platform: ruby
-authors: 
-- Sascha Brink
+authors:
+- InterFAX
+- Cristiano Betta
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-04 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
+date: 2016-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: A ruby wrapper for the interfax webservice (SOAP)
-email: sascha.brink@gmail.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper around the InterFAX REST API for sending and receiving faxes.
+email:
+- dev@interfax.net
+- cbetta@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files: []
+files:
 - LICENSE
-- README.markdown
-files: 
-- LICENSE
-- README.markdown
-- Rakefile
-- VERSION
+- README.md
+- interfax.gemspec
 - lib/interfax.rb
-- lib/interfax/base.rb
-- lib/interfax/fax_item.rb
-- lib/interfax/incoming.rb
-- spec/incoming_helper.rb
-- spec/incoming_spec.rb
-- spec/interfax_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/sbrink/interfax
-licenses: []
-
+- lib/interfax/account.rb
+- lib/interfax/client.rb
+- lib/interfax/file.rb
+- lib/interfax/forwarding_email.rb
+- lib/interfax/image.rb
+- lib/interfax/inbound.rb
+- lib/interfax/inbound/fax.rb
+- lib/interfax/object.rb
+- lib/interfax/outbound.rb
+- lib/interfax/outbound/delivery.rb
+- lib/interfax/outbound/fax.rb
+- lib/interfax/version.rb
+homepage: https://github.com/interfax/interfax-ruby
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
-summary: A ruby wrapper for the interfax webservice (SOAP)
-test_files: 
-- spec/incoming_helper.rb
-- spec/incoming_spec.rb
-- spec/interfax_spec.rb
-- spec/spec_helper.rb
+specification_version: 4
+summary: Send and receive faxes with InterFAX
+test_files: []