sfax 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74afcc0d5d5f12617755eb6a4f7e278ec822550e
+  data.tar.gz: 2f3847a6d32c964084bec36f96c856bf6791e909
+SHA512:
+  metadata.gz: 0f9dfb22c0fa53fac0f78aef202835ccf7e4225d9eec7b5e00be899c0ce6123500ab5b5dfa2c16fb3bdf121eb53f126b60c687c01db1025cf6a860e031d6c4f2
+  data.tar.gz: c2abb34593bb8fbe8f2d301f3806581e5a4e1597435ae6062a7fff39b8f17a78891c7e223bc2b0b80833226844a08176caba100ac962fc353fa0f4c089b281bb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format=documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Derek Schneider
+
+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,19 @@
+# SFax API Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sfax'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sfax
+
+## Usage

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -I"
+end

data/lib/sfax.rb

@@ -0,0 +1,8 @@
+require 'sfax/client'
+require 'sfax/encryptor'
+require 'sfax/version'
+require 'faraday'
+require 'json'
+
+module SFax
+end

data/lib/sfax/client.rb

@@ -0,0 +1,72 @@
+require 'sfax/encryptor'
+require 'sfax/version'
+require 'sfax/constants'
+require 'faraday'
+require 'json'
+
+module SFax
+  class Client
+    include Constants
+
+    def initialize(username:, api_key:, encryption_key:)
+      @username = username
+      @api_key = api_key
+      @encryptor = SFax::Encryptor.new(key: encryption_key)
+    end
+
+    def send_fax(fax_number:, file:, recipient_name:)
+      validate_fax_number fax_number
+
+      response = connection.post SEND_FAX_PATH do |request|
+        request.params = {
+          'token' => generate_token,
+          'ApiKey' => api_key,
+          'RecipientFax' => fax_number,
+          'RecipientName' => recipient_name,
+        }
+        request.body = {
+          file: Faraday::UploadIO.new(file, 'application/pdf', "#{gen_dt}.pdf")
+        }
+      end
+
+      response_object = JSON.parse(response.body)
+      # TODO: Refactor into proper response objec.
+      def response_object.fax_id
+        fetch('SendFaxQueueId')
+      end
+
+      response_object.tap do |o|
+        raise SendFaxError if o.fax_id == -1
+      end
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: SFAX_URL) do |faraday|
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    attr_reader :username, :api_key, :encryptor
+
+    def generate_token
+      encryptor.encrypt "Username=#{username}&ApiKey=#{api_key}&GenDT=#{gen_dt}"
+    end
+
+    def gen_dt
+      Time.now.utc.iso8601
+    end
+
+    def validate_fax_number(number)
+      if number.to_i == 0 || number.length != 11
+        raise InvalidFaxNumberError, "Expected an 11 digit fax number. Got: #{number}"
+      end
+    end
+
+    InvalidFaxNumberError = Class.new(StandardError)
+    SendFaxError = Class.new(StandardError)
+  end
+end

data/lib/sfax/constants.rb

@@ -0,0 +1,6 @@
+module SFax
+  module Constants
+    SFAX_URL = 'https://api.sfaxme.com'.freeze
+    SEND_FAX_PATH = '/api/sendfax'.freeze
+  end
+end

data/lib/sfax/encryptor.rb

@@ -0,0 +1,34 @@
+require 'openssl'
+require 'base64'
+
+module SFax
+  class Encryptor
+    DEFAULT_IV = 'x49e*wJVXr8BrALE'.freeze
+    OPEN_SSL_CIPHER = 'aes-256-cbc'.freeze
+
+    def initialize(key:, iv: DEFAULT_IV)
+      @key = key.dup
+      @iv = iv
+    end
+
+    attr_reader :key, :iv
+
+    def encrypt(plain)
+      cipher = new_encrypt_cipher
+
+      encrypted_data = cipher.update plain
+      encrypted_data << cipher.final
+
+      Base64.encode64 encrypted_data
+    end
+
+    def new_encrypt_cipher
+      OpenSSL::Cipher::Cipher.new(OPEN_SSL_CIPHER).tap do |c|
+        c.encrypt
+
+        c.key = key
+        c.iv = iv
+      end
+    end
+  end
+end

data/lib/sfax/version.rb

@@ -0,0 +1,3 @@
+module SFax
+  VERSION = '0.1.1'
+end

data/sfax.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sfax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sfax'
+  spec.version       = SFax::VERSION
+  spec.authors       = ['Derek Schneider']
+  spec.email         = ['dschneider.641@gmail.com']
+  spec.summary       = %q{Ruby client for SFax API}
+  spec.description   = %q{Ruby client for SFax API}
+  spec.homepage      = 'https://github.com/schneiderderek/sfax'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

data/spec/sfax_client_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+RSpec.describe SFax::Client do
+  subject do
+    described_class.new(
+      username: username,
+      api_key: api_key,
+      encryption_key: encryption_key,
+    )
+  end
+  let(:username) { SecureRandom.hex }
+  let(:api_key) { SecureRandom.hex }
+  let(:encryption_key) { SecureRandom.hex }
+
+  describe '#send_fax' do
+    let(:fax_number) { nil }
+    let(:file) { StringIO.new('data') }
+    let(:recipient_name) { nil }
+    let(:token) { SecureRandom.hex }
+    let(:send_fax_queue_id) { rand(1_000_000) }
+    let!(:send_fax_request) do
+      stub_request(:post, 'https://api.sfaxme.com/api/sendfax').with(query: {
+        'token' => token,
+        'ApiKey' => api_key,
+        'RecipientFax' => fax_number,
+        'RecipientName' => recipient_name,
+      }).and_return(body: {
+        'SendFaxQueueId' => send_fax_queue_id,
+      }.to_json)
+    end
+
+    before do
+      # I'd prefer not to stub this, but I think this is the easiest way
+      # currently.
+      allow(subject).to receive(:generate_token).and_return(token)
+    end
+
+    context 'valid fax number' do
+      let(:fax_number) { '15555555555' }
+
+      context 'valid send_fax_queue_id in response' do
+        let(:send_fax_queue_id) { rand(1_000_000) }
+
+        specify do
+          response = subject.send_fax(fax_number: fax_number, file: file, recipient_name: recipient_name)
+
+          expect(response.fax_id).to eq send_fax_queue_id
+          expect(send_fax_request).to have_been_requested
+        end
+      end
+
+      context 'send_fax_queue_id is -1' do
+        let(:send_fax_queue_id) { -1 }
+
+        specify do
+          expect {
+            subject.send_fax(fax_number: fax_number, file: file, recipient_name: recipient_name)
+          }.to raise_error(described_class::SendFaxError)
+
+          expect(send_fax_request).to have_been_requested
+        end
+      end
+    end
+
+    shared_examples :invdalid_fax_number_error do
+      specify do
+        expect {
+          subject.send_fax(fax_number: fax_number, file: file, recipient_name: recipient_name)
+        }.to raise_error(described_class::InvalidFaxNumberError)
+      end
+    end
+
+    context 'fax number 10 digits' do
+      let(:fax_number) { '5555555555' }
+
+      include_examples :invdalid_fax_number_error
+    end
+
+    context 'fax number not a number' do
+      let(:fax_number) { 'a' }
+
+      include_examples :invdalid_fax_number_error
+    end
+  end
+end

data/spec/sfax_encryptor_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe SFax::Encryptor do
+  let(:key) { SecureRandom.hex }
+  subject do
+    described_class.new(key: key)
+  end
+
+  describe '#encrypt' do
+    specify do
+      expect { subject.encrypt('a') }.not_to raise_error
+    end
+
+    specify do
+      expect(subject.encrypt('a')).to be_a String
+    end
+  end
+end

data/spec/sfax_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+RSpec.describe SFax do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'sfax'
+require 'webmock/rspec'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: sfax
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Derek Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Ruby client for SFax API
+email:
+- dschneider.641@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sfax.rb
+- lib/sfax/client.rb
+- lib/sfax/constants.rb
+- lib/sfax/encryptor.rb
+- lib/sfax/version.rb
+- sfax.gemspec
+- spec/sfax_client_spec.rb
+- spec/sfax_encryptor_spec.rb
+- spec/sfax_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/schneiderderek/sfax
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for SFax API
+test_files:
+- spec/sfax_client_spec.rb
+- spec/sfax_encryptor_spec.rb
+- spec/sfax_spec.rb
+- spec/spec_helper.rb