invoice_maker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f67e03c7be70612a9652351ede322783d6942ed
+  data.tar.gz: 3913f1c725d444678a007bdd1ae87db9825805fd
+SHA512:
+  metadata.gz: 7b76f3928b9955d3f070e9478640b5ad1fdc1b42c75b3833a5e75fc26cab4d1462ed3c9025315312c8a23a5296029421e464213a35cb2dc52f121cbe2f82a053
+  data.tar.gz: 315f86de186ef3995cdb7f5a80bb13ec0ed05bab790c69e2653fc859f57b7c0cdf14865e8901e89325760a082f4de026d4e6f0a15c1d317e2da8e542881c0566

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.vendor/
+/vendor/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Horton
+
+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,96 @@
+[![CircleCI](https://circleci.com/gh/hortoncd/invoice_maker.svg?style=svg)](https://circleci.com/gh/hortoncd/invoice_maker)
+
+# InvoiceMaker
+
+A gem to do the basic work of creating a PDF invoice using https://invoice-generator.com.  Inspired by
+the article here:
+https://gelato.io/blog/minimum-viable-ruby-api-client-with-invoiced-and-httparty.
+
+API documentation lives at https://github.com/Invoiced/invoice-generator-api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'invoice_maker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install invoice_maker
+
+## Usage
+
+Require the gem, and optionally include the module for simplicity
+```ruby
+require 'invoice_maker'
+
+include InvoiceMaker
+```
+
+The gem relies on general options for the invoice being set with the 'set' method.  This can include all the line items, or they can be added individually after initial options are set.
+
+The basic data can include any of the options documented in the API documentation referenced above.  A 
+
+```ruby
+data = {
+  "from": "My Great Company, Inc. ®\nMy Street Address\nMy City, State 00000",
+  "to": "My Great Customer\nATTN: The Dude\nCust Address\nCust Street Address\nCust City, State 11111",
+  "logo": "http://placekitten.com/320/140",
+  "number": 1,
+  "date": "2016-10-24",
+  "items": [
+    {
+      "name": "Some awesome task",
+      "quantity": 1,
+      "unit_cost": 270.0
+    }
+  ],
+  "notes": "Thank you so much for your business!"
+}
+```
+
+Instantiate an object and add the data, followed by adding any line items as necessary.
+```ruby
+i = Invoice
+i.set(data)
+
+item = {
+  "name": "Some additional awesome task",
+  "quantity": 2,
+  "unit_cost": 270.0
+}
+
+i.append_item(item)
+```
+Optionally set a destination directory for the generated PDF invoice.  Default is "/tmp".
+```ruby
+i.dest_dir = "/somedir"
+```
+
+Once all data is set, generate the PDF invoice.  The filename will be returned from the call to generate.
+```ruby
+fname = i.generate
+puts fname
+```
+
+`examples/usage.rb` is a sample script that loads data from a json file and generates a sample invoice.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hortoncd/invoice_maker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "invoice_maker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/invoice_in.json

@@ -0,0 +1,20 @@
+{
+  "from": "My Great Company, Inc. ®\nMy Street Address\nMy City, State 00000",
+  "to": "My Great Customer\nATTN: The Dude\nCust Address\nCust Street Address\nCust City, State 11111",
+  "logo": "http://placekitten.com/320/140",
+  "number": 1,
+  "date": "2016-10-24",
+  "items": [
+    {
+      "name": "Some awesome task",
+      "quantity": 1,
+      "unit_cost": 270.0
+    },
+    {
+      "name": "Some other task",
+      "quantity": 2,
+      "unit_cost": 270.0
+                            }
+  ],
+  "notes": "Thank you so much for your business!"
+}

data/examples/usage.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require 'invoice_maker'
+include InvoiceMaker
+
+i = Invoice.new
+puts "i is an instance of an #{i.class} class."
+puts
+
+data = JSON.parse(File.open(File.join(File.dirname(__FILE__), 'invoice_in.json'), 'r').read)
+puts "data is the JSON that will be sent to the api to generate the invoice:"
+puts data
+puts
+
+i.set(data)
+fname = i.generate
+
+puts "After generation, we have a pdf file name, or 'nil' to indicate and error:"
+if fname
+  puts fname
+else
+  puts "Failed to generate invoice."
+end

data/fixtures/invoice_appended.json

@@ -0,0 +1,20 @@
+{
+  "from": "My Great Company, Inc. ®\nMy Street Address\nMy City, State 00000",
+  "to": "My Great Customer\nATTN: The Dude\nCust Address\nCust Street Address\nCust City, State 11111",
+  "logo": "http://placekitten.com/320/140",
+  "number": 1,
+  "date": "2016-10-24",
+  "items": [
+    {
+      "name": "Some awesome task",
+      "quantity": 1,
+      "unit_cost": 270.0
+    },
+    {
+      "name": "Some other task",
+      "quantity": 2,
+      "unit_cost": 270.0
+                            }
+  ],
+  "notes": "Thank you so much for your business!"
+}

data/fixtures/invoice_in.json

@@ -0,0 +1,15 @@
+{
+  "from": "My Great Company, Inc. ®\nMy Street Address\nMy City, State 00000",
+  "to": "My Great Customer\nATTN: The Dude\nCust Address\nCust Street Address\nCust City, State 11111",
+  "logo": "http://placekitten.com/320/140",
+  "number": 1,
+  "date": "2016-10-24",
+  "items": [
+    {
+      "name": "Some awesome task",
+      "quantity": 1,
+      "unit_cost": 270.0
+    }
+  ],
+  "notes": "Thank you so much for your business!"
+}

data/invoice_maker.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'invoice_maker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "invoice_maker"
+  spec.version       = InvoiceMaker::VERSION
+  spec.authors       = ["Chris Horton"]
+  spec.email         = ["hortoncd@gmail.com"]
+
+  spec.summary       = %q{Generate simple invoices using https://invoice-generator.com}
+  spec.description   = %q{Generate simple invoices using https://invoice-generator.com.}
+  spec.homepage      = "https://github.com/hortoncd/invoice_maker"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_dependency "httparty", "~> 0.14.0"
+end

data/lib/invoice_maker/invoice.rb

@@ -0,0 +1,50 @@
+module InvoiceMaker
+  class Invoice
+    PDF_CONTENT_TYPE  = 'application/pdf'
+    JSON_CONTENT_TYPE = 'application/json'
+
+    attr_accessor :dest_dir
+    attr_reader :data
+
+    def initialize
+      @dest_dir = '/tmp'
+      @data = Hash.new
+      @base_uri = 'https://invoice-generator.com'
+    end
+
+    # set invoice data
+    def set(options = {})
+      @data = options
+    end
+
+    def data
+      @data
+    end
+
+    def append_item(item)
+      raise "Unable to add items to an empty invoice data.  Did you 'set' first?" if @data.empty?
+      @data['items'] = [] unless @data.has_key?('items')
+      @data['items'].push item unless @data.empty?
+    end
+
+    # Let's generate a pdf
+    def generate
+      response = HTTParty.post(@base_uri, body: @data.to_json, headers: { "Content-Type" => JSON_CONTENT_TYPE })
+      if response.success? && response.content_type == PDF_CONTENT_TYPE
+        filename = File.join(@dest_dir, SecureRandom.urlsafe_base64(16)) + '.pdf'
+        save_pdf(filename, response.parsed_response)
+      else
+        return nil
+      end
+      return filename
+    end
+
+    private
+
+    def save_pdf(filename, data)
+      File.open(filename, "wb+") do |f|
+        f << data
+      end
+    end
+  end
+end

data/lib/invoice_maker/version.rb

@@ -0,0 +1,3 @@
+module InvoiceMaker
+  VERSION = "0.1.0"
+end

data/lib/invoice_maker.rb

@@ -0,0 +1,5 @@
+require 'invoice_maker/version'
+require 'invoice_maker/invoice'
+
+require 'httparty'
+require 'securerandom'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: invoice_maker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Horton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Generate simple invoices using https://invoice-generator.com.
+email:
+- hortoncd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/invoice_in.json
+- examples/usage.rb
+- fixtures/invoice.pdf
+- fixtures/invoice_appended.json
+- fixtures/invoice_in.json
+- invoice_maker.gemspec
+- lib/invoice_maker.rb
+- lib/invoice_maker/invoice.rb
+- lib/invoice_maker/version.rb
+homepage: https://github.com/hortoncd/invoice_maker
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Generate simple invoices using https://invoice-generator.com
+test_files: []