paperplane-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ef3026a3b88856233f3e9d4cfea8f165f126bd240de7808dfba2e205baba9e0
+  data.tar.gz: 6702fe14e39f56d4060a505de5505835acc10cfd4a3a823844ac9f2d1c90af5a
+SHA512:
+  metadata.gz: 40dff58c30f2d294a8d05d689420be03a0177c3c53c4a224be5b70d9e575db4ceaa19202dff5848b0bb177d49e1b427288f473916f0e02cb69167c5cf30786ac
+  data.tar.gz: c979966d45b8b0ae4c1ea48bf6706bb41ba0347329ebe668b9beb806a7cad23245e67d65fecb61b7bf9d2a4d3aa7bf5e58f96a73d7124daf857d8d065fb2e7b7

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-03-28
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in paperplane.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem 'http'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    paperplane-rb (0.1.0)
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    public_suffix (5.0.1)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  http
+  paperplane-rb!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.26

data/README.md

@@ -0,0 +1,29 @@
+# Paperplane
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paperplane`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add paperplane
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install paperplane
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/[USERNAME]/paperplane.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/paperplane/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Paperplane
+  VERSION = "0.1.0"
+end

data/lib/paperplane.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "paperplane/version"
+require 'http'
+
+module Paperplane
+  class Error < StandardError; end
+
+  class << self
+    BASE_URL = 'https://api.paperplane.app/v1'.freeze
+    ENDPOINTS = {
+      create_job: '/jobs',
+      show_job: '/jobs/%{id}',
+      download_pdf: 'https://download.paperplane.app/'
+    }.freeze
+    PAGE_SIZES = %w[A4 Letter Legal Tabloid].freeze
+
+    attr_accessor :api_key
+
+    def create_job(url, page_size = 'A4')
+      validate_page_size(page_size)
+      perform_request(:post, :create_job, url, page_size:)
+    end
+
+    def show_job(id)
+      perform_request(:get, :show_job, id)
+    end
+
+    def download_pdf(url, page_size = 'A4')
+      validate_page_size(page_size)
+      perform_request(:post, :download_pdf, url, page_size:)
+    end
+
+    private
+
+    def http_client
+      @http_client ||= HTTP.basic_auth(user: @api_key, pass: '')
+    end
+
+    def perform_request(method, endpoint_name, *args)
+      url = build_url(endpoint_name, args[0])
+      response = http_client.request(method, url, json: args[1])
+      handle_error(response)
+      response.parse
+    end
+
+    def build_url(endpoint_name, id)
+      endpoint = ENDPOINTS[endpoint_name]
+      endpoint.include?('://') ? endpoint : "#{BASE_URL}#{format(endpoint, id:)}"
+    end
+
+    def handle_error(response)
+      raise Paperplane::Error, response.parse['message'] if response.status >= 400
+    end
+
+    def validate_page_size(page_size)
+      raise ArgumentError, "Invalid page size '#{page_size}'" unless PAGE_SIZES.include?(page_size)
+    end
+  end
+end

data/paperplane.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/paperplane/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "paperplane-rb"
+  spec.version = Paperplane::VERSION
+  spec.authors = ["nolyoi"]
+  spec.email = ["nolan@syslogica.io"]
+
+  spec.summary = "A gem to interact with the Paperplane PDF API."
+  spec.description = "A gem to interact with the Paperplane PDF API."
+  spec.homepage = "https://github.com/nolyoi"
+  spec.required_ruby_version = ">= 2.6.0"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nolyoi/paperplane-rb"
+  spec.metadata["changelog_uri"] = "https://github.com/nolyoi/paperplane-rb/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "http"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/paperplane.rbs

@@ -0,0 +1,4 @@
+module Paperplane
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: paperplane-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nolyoi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to interact with the Paperplane PDF API.
+email:
+- nolan@syslogica.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/paperplane.rb
+- lib/paperplane/version.rb
+- paperplane.gemspec
+- sig/paperplane.rbs
+homepage: https://github.com/nolyoi
+licenses: []
+metadata:
+  homepage_uri: https://github.com/nolyoi
+  source_code_uri: https://github.com/nolyoi/paperplane-rb
+  changelog_uri: https://github.com/nolyoi/paperplane-rb/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A gem to interact with the Paperplane PDF API.
+test_files: []