paperplane-rb 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8650245780e13bcc390fcc98d5628c523077cf443a8776563bfa95c528429397
-  data.tar.gz: 000b39399abe1e6909f46f28f23d99bdfca7bdc7f2722ac5750311a901c96212
+  metadata.gz: 7bac605d7028446810334ec5ce9f549ce2a40884aa766dc82d30384145b85bf8
+  data.tar.gz: 1f6055b1cf36e3562861598e7d839a8086ddd03a9cb537bc9954e98532320e7a
 SHA512:
-  metadata.gz: a92b8cf658f491043a937359d0494e811219965fef14fcf9521d536f05e3b64f831b8ae5915f9a11611ff48a23f772c9696e7e3b8923914306a9a563739d12e5
-  data.tar.gz: 9886f0011b89563d4b9ab7970e424006124cc033408f115b1ac1eaab822aeece9e682fc768a2070fbdc6a1b30f32e7a85967ad5644770cd2d512e10ecd7990e1
+  metadata.gz: e5880a18a09467a0a9cd48146b10977d842ceb0acd22deca2491dc9466d160d1126a7d140c7daa8d7b70620f1c6adf6da20f38318e8e718bb37934fd1e728f0e
+  data.tar.gz: ed739ace7d040964123f9898115fda612b4c780df711c8d21f396a5f050f4ede22ac2c0a7ee0edb83dd264763eec51c0105445efeafd40ad90e5853668a818d7

data/Gemfile

@@ -8,5 +8,3 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
-
-gem 'http'

data/Gemfile.lock

@@ -1,14 +1,17 @@
 PATH
   remote: .
   specs:
-    paperplane-rb (0.1.5)
+    paperplane-rb (0.1.8)
       http
+      webmock
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -16,6 +19,7 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    hashdiff (1.0.1)
     http (5.1.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
@@ -29,6 +33,7 @@ GEM
       rake (~> 13.0)
     public_suffix (5.0.1)
     rake (13.0.6)
+    rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -45,12 +50,16 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
-  http
   paperplane-rb!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -1,8 +1,6 @@
-# Paperplane
+# paperplane-rb
 
-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
+A simple gem to interact with the Paperplane PDF API. It just has very basic features that I needed quickly. I'll continue to improve this as I need. Feel free to contribute if you'd like!
 
 ## Installation
 
@@ -10,20 +8,41 @@ 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:
+Or add it to your `Gemfile` manually:
 
-    $ gem install paperplane
+```ruby
+gem '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).
+Initialize the library and set your API key(required) and logger(optional).
+```ruby
+    require 'paperplane'
+
+    Paperplane.configure do |config|
+    config.api_key = 'your_paperplane_api_key'
+    config.logger = Appsignal::Logger.new("paperplane")
+    end
+```
+
+You can now call the different methods:
+```ruby
+    # Download PDF
+    url = 'https://en.wikipedia.org/wiki/Airplane'
+    output_file = 'example.pdf'
+    PaperplaneAPI.download_pdf(url, output_file)
+
+    # Create Job
+    response = PaperplaneAPI.create_job(url)
+    puts response
+    job_id = response['id']
+
+    # Show Job
+    job = PaperplaneAPI.show_job(job_id)
+    puts job
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/paperplane.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nolyoi/paperplane-rb.

data/lib/paperplane/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require 'logger'
+
+class Config
+  attr_accessor :api_key, :logger
+
+  def initialize
+    @api_key = ''
+    @logger = Logger.new(STDOUT)
+  end
+end

data/lib/paperplane/error.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 module Paperplane
-  class Error < StandardError 
+  class Error < StandardError
+    def initialize(message)
+      Paperplane.config.logger.error(message)
+      super(message)
+    end
   end
 end

data/lib/paperplane/version.rb

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

data/lib/paperplane.rb

@@ -1,67 +1,66 @@
 # frozen_string_literal: true
 
 require 'http'
+require 'paperplane/config'
 require 'paperplane/error'
 require 'paperplane/version'
 
 module Paperplane
   ENDPOINTS = {
-    create_job: 'https://api.paperplane.app/v1/jobs',
-    show_job: 'https://api.paperplane.app/v1/jobs/%{id}',
-    download_pdf: 'https://download.paperplane.app/'
+    download_pdf: 'https://download.paperplane.app/',
+    jobs: 'https://api.paperplane.app/jobs'
   }.freeze
-  PAGE_SIZES = %w[Letter Legal A3 A4 A5].freeze
 
   class << self
-    attr_accessor :api_key
+    attr_writer :config
 
-    def configure
-      yield self
+    def config
+      @config ||= Config.new
     end
 
-    def create_job(url, page_size: 'A4')
-      validate_page_size!(page_size)
-      perform_request(:post, :create_job, url: url, page_size: page_size)
+    def configure
+      yield(config) if block_given?
     end
 
-    def show_job(id)
-      perform_request(:get, :show_job, id)
+    def version
+      @version ||= Paperplane::VERSION
     end
 
-    def download_pdf(url, page_size: 'A4')
-      response = HTTP.basic_auth(user: self.api_key, pass: "").post(
-        "https://download.paperplane.app",
-        json: { url: url, page_size: page_size }
-      )
-      response.body.to_s
+    def client
+      @client ||= HTTP.basic_auth(user: config.api_key, pass: '')
     end
 
-    private
-
-    def http_client
-      @http_client ||= HTTP.basic_auth(user: api_key, pass: '')
+    def prepare_params(url, page_size: 'A4')
+      params = { url: url, page_size: page_size }
     end
 
-    def perform_request(method, endpoint_name, *args)
-      url = build_url(endpoint_name, *args)
-      puts url
-      puts args
-      response = http_client.request(method, url.to_s, json: args.to_json)
-      puts response.parse
-      validate_response!(response)
+    # Download PDF
+    def download_pdf(url, page_size: 'A4')
+      params = prepare_params(url, page_size: page_size)
+      response = client.post(ENDPOINTS[:download_pdf], form: params)
+      raise Paperplane::Error, "Failed to download PDF: #{response.status}" unless response.status.success?
+      
+      config.logger.info("Downloaded PDF: #{url}")
+      response.body.to_s
     end
 
-    def build_url(endpoint_name, *args)
-      format(ENDPOINTS[endpoint_name], args)
-    end
+    # Create Job
+    def create_job(url, page_size: 'A4', options: {})
+      params = prepare_params(url, page_size: page_size)
+      response = client.post(ENDPOINTS[:jobs], form: params.merge(options))
+      raise Paperplane::Error, "Failed to create job: #{response.status}" unless response.status.success?
 
-    def validate_response!(response)
-      # raise Paperplane::Error, response.parse['message'] if response.status >= 400
+      config.logger.info("Created job for URL: #{url}")
       response.parse
     end
 
-    def validate_page_size!(page_size)
-      raise ArgumentError, "Invalid page size '#{page_size}'" unless PAGE_SIZES.include?(page_size)
+    # Show Job
+    def show_job(job_id)
+      response = client.get("#{ENDPOINTS[:jobs]}/#{job_id}")
+      raise Paperplane::Error, "Failed to show job: #{response.status}" unless response.status.success?
+
+      config.logger.info("Fetched job: #{job_id}")
+      response.parse
     end
   end
 end

data/paperplane.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "http"
+  spec.add_dependency "webmock"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperplane-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - nolyoi
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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
@@ -38,10 +52,10 @@ files:
 - README.md
 - Rakefile
 - lib/paperplane.rb
+- lib/paperplane/config.rb
 - lib/paperplane/error.rb
 - lib/paperplane/version.rb
 - paperplane.gemspec
-- sig/paperplane.rbs
 homepage: https://github.com/nolyoi
 licenses: []
 metadata:

data/sig/paperplane.rbs

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