faxomat-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a65176c45a7d314b7f4ccfe43e25369981c589e
+  data.tar.gz: 121ab7a4355492cd200a493ff75c82213de744cb
+SHA512:
+  metadata.gz: 5655b57ebdb48e1d41b98594df48d90e72b497b4db0ceeda68eda14704947fa7982446d1aa5cae7094a376a3635f055f23e700344b6b974c473a24fe49713ffa
+  data.tar.gz: d8212319b143290fb8211e19eef6d7c84ef3387a846966830796b7cbeb87072166efab97e4f534daefdedf56beff5b3e4824e4cbf8a94284169ab07b6b9283e7

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Björn Albers
+
+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,15 @@
+# Faxomat-Client
+
+Client for Faxomat HTTP-API.
+
+## Installation
+
+    $ gem install faxomat-client
+
+## Usage
+
+    $ faxomat --phone 0123456789 --title 'Chunky Bacon' chunky.pdf
+
+## Copyright
+
+Copyright 2015 Björn Albers

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/faxomat

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'faxomat/client'
+
+include Faxomat::Client
+
+opts = CLI.new.parse(ARGV)
+path = opts.args.first
+raise "File is missing!" unless path
+Fax.new(phone: opts[:phone], title: opts[:title], path: path).deliver

data/faxomat-client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faxomat/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'faxomat-client'
+  spec.version       = Faxomat::Client::VERSION
+  spec.authors       = ['Björn Albers']
+  spec.email         = ['bjoernalbers@gmail.com']
+  spec.summary       = "#{spec.name}-#{spec.version}"
+  spec.description   = 'Client for Faxomat HTTP API'
+  spec.homepage      = 'https://github.com/bjoernalbers/faxomat-client'
+  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_dependency 'slop', '~> 4.0'
+  spec.add_dependency 'rest-client', '~> 1.7'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/faxomat/client.rb

@@ -0,0 +1,5 @@
+require 'slop'
+require 'rest-client'
+require 'faxomat/client/version'
+require 'faxomat/client/fax'
+require 'faxomat/client/cli'

data/lib/faxomat/client/cli.rb

@@ -0,0 +1,12 @@
+module Faxomat
+  module Client
+    class CLI
+      def parse(argv)
+        Slop.parse(argv) do |o|
+          o.string '-p', '--phone', 'phone number of recipient'
+          o.string '-t', '--title', 'title of fax'
+        end
+      end
+    end
+  end
+end

data/lib/faxomat/client/fax.rb

@@ -0,0 +1,39 @@
+module Faxomat
+  module Client
+    class Fax
+      attr_reader :phone, :title, :path
+
+      def initialize(opts={})
+        @phone = opts[:phone]
+        @title = opts[:title]
+        @path  = opts[:path]
+      end
+
+      def deliver
+        RestClient.post url, params
+      ensure
+        file.close unless file.closed?
+      end
+
+      private
+
+      def url
+        'http://faxomat/faxes'
+      end
+
+      def params
+        {
+          fax: {
+            phone:    phone,
+            title:    title,
+            document: file
+          }
+        }
+      end
+
+      def file
+        @file ||= File.new(path, 'rb')
+      end
+    end
+  end
+end

data/lib/faxomat/client/version.rb

@@ -0,0 +1,5 @@
+module Faxomat
+  module Client
+    VERSION = '0.1.0'
+  end
+end

data/spec/faxomat/client/cli_spec.rb

@@ -0,0 +1,21 @@
+describe Faxomat::Client::CLI do
+  let(:cli) { Faxomat::Client::CLI.new }
+  let(:argv) { %w(--phone 0123456789 --title chunky chunky.pdf) }
+
+  describe '#parse' do
+    it 'assigns phone' do
+      opts = cli.parse(argv)
+      expect(opts[:phone]).to eq '0123456789'
+    end
+
+    it 'assigns title' do
+      opts = cli.parse(argv)
+      expect(opts[:title]).to eq 'chunky'
+    end
+
+    it 'assigns args' do
+      opts = cli.parse(argv)
+      expect(opts.args).to eq ['chunky.pdf']
+    end
+  end
+end

data/spec/faxomat/client/fax_spec.rb

@@ -0,0 +1,18 @@
+describe Faxomat::Client::Fax do
+  let(:fax) { Faxomat::Client::Fax.new(phone: '0123456789', title: 'chunky bacon', path: 'chunky.pdf') }
+
+  describe '#deliver' do
+    it 'faxes via HTTP' do
+      file = double('file')
+      allow(file).to receive(:close)
+      allow(fax).to receive(:file).and_return(file)
+      url = 'http://faxomat/faxes'
+      params = { phone: '0123456789',
+                 title: 'chunky bacon',
+                 document: file }
+      allow(RestClient).to receive(:post)
+      fax.deliver
+      expect(RestClient).to have_received(:post).with(url, params)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,91 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end
+
+require 'faxomat/client'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: faxomat-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Björn Albers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Client for Faxomat HTTP API
+email:
+- bjoernalbers@gmail.com
+executables:
+- faxomat
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/faxomat
+- faxomat-client.gemspec
+- lib/faxomat/client.rb
+- lib/faxomat/client/cli.rb
+- lib/faxomat/client/fax.rb
+- lib/faxomat/client/version.rb
+- spec/faxomat/client/cli_spec.rb
+- spec/faxomat/client/fax_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bjoernalbers/faxomat-client
+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.0.14
+signing_key: 
+specification_version: 4
+summary: faxomat-client-0.1.0
+test_files:
+- spec/faxomat/client/cli_spec.rb
+- spec/faxomat/client/fax_spec.rb
+- spec/spec_helper.rb