ruby-superparser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd3ec2e737d36d5496e842dac973746f9db2de3400ba26eff4df4833a96ba01d
+  data.tar.gz: c2b11e0282c9c4d4d8700709939ab5a4dbd364d9fbaff4a33484e81574a5a47c
+SHA512:
+  metadata.gz: 5729012f101cdeece775f4216cb277573d65d1bee6b49345151ec4999804b71ac9996debfd1f70120e8366332fb7667e4fd65db17c1aea2fcf0d6cf893bd35bd
+  data.tar.gz: 1b5d053e783d85b94a19ff9f822932bc938f5f591707c12cb28a61e57c0c72beffee33691b45d618b1588a0b77b514e69243cf2cecab765d65c58f3cb6f5a68d

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-25
+
+- Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 JP Silvashy
+
+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,70 @@
+# Ruby Superparser
+
+Ruby Superparser is a gem that simplifies making HTTP requests to the SuperParser API for parsing resume documents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-superparser', git: 'https://github.com/jpsilvashy/ruby-superparser.git'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install ruby-superparser
+```
+
+## Usage
+
+1. Set the `SUPERPARSER_API_KEY` environment variable with your SuperParser API key:
+
+```sh
+export SUPERPARSER_API_KEY=your_api_key_here
+```
+
+### In a Rails application
+
+To use this gem in a Rails application, run the generator to create an initializer:
+
+```sh
+rails generate ruby_superparser:install
+```
+
+This will create a `config/initializers/ruby_superparser.rb` file, which initializes the `SUPERPARSER_CLIENT` constant.
+
+Now you can use the gem throughout your Rails application:
+
+```ruby
+json_result = SUPERPARSER_CLIENT.parse_resume('path/to/your/resume.pdf')
+puts json_result
+```
+
+### In other Ruby applications
+
+In other Ruby applications, create a `Client` instance and use it to parse resumes:
+
+```ruby
+require 'ruby_superparser'
+
+api_key = ENV['SUPERPARSER_API_KEY']
+client = RubySuperparser::Client.new(api_key)
+json_result = client.parse_resume('path/to/your/resume.pdf')
+puts json_result
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jpsilvashy/ruby-superparser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jpsilvashy/ruby-superparser/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ruby/superparser"
+
+# 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(__FILE__)

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/lib/generators/ruby_superparser/install_generator.rb

@@ -0,0 +1,13 @@
+# lib/generators/ruby_superparser/install_generator.rb
+
+require 'rails/generators/base'
+
+module RubySuperparser
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def create_initializer_file
+      copy_file 'initializer.rb', 'config/initializers/ruby_superparser.rb'
+    end
+  end
+end

data/lib/generators/ruby_superparser/templates/initializer.rb

@@ -0,0 +1,4 @@
+# lib/generators/ruby_superparser/templates/initializer.rb
+
+api_key = ENV['SUPERPARSER_API_KEY']
+SUPERPARSER_CLIENT = RubySuperparser::Client.new(api_key)

data/lib/ruby/superparser/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Superparser
+    VERSION = "0.1.0"
+  end
+end

data/lib/ruby/superparser.rb

@@ -0,0 +1,38 @@
+# lib/ruby_superparser.rb
+
+require 'net/http'
+require 'net/http/post/multipart'
+
+module RubySuperparser
+  class Client
+    API_URL = 'https://api.superparser.com/parse'.freeze
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def parse_resume(file_path)
+      uri = URI(API_URL)
+
+      request = Net::HTTP::Post::Multipart.new(uri.path,
+        'file_name' => UploadIO.new(File.open(file_path), 'application/pdf')
+      )
+      request['accept'] = 'application/json'
+      request['X-API-Key'] = @api_key
+      request['Content-Type'] = 'multipart/form-data'
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      response = http.request(request)
+
+      if response.is_a?(Net::HTTPSuccess)
+        puts 'Successfully parsed the document'
+        return response.body
+      else
+        puts 'Failed to parse the document'
+        return nil
+      end
+    end
+  end
+end

data/ruby-superparser.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby/superparser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-superparser"
+  spec.version = Ruby::Superparser::VERSION
+  spec.authors = ["JP Silvashy"]
+  spec.email = ["jpsilvashy@gmail.com"]
+
+  spec.summary       = %q{A Ruby client for the SuperParser API}
+  spec.description   = %q{The Ruby Superparser gem simplifies making HTTP requests to the SuperParser API for parsing resume documents.}
+  spec.homepage      = "https://github.com/jpsilvashy/ruby-superparser"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = "https://github.com/jpsilvashy/ruby-superparser"
+  spec.metadata["source_code_uri"] = "https://github.com/jpsilvashy/ruby-superparser"
+  spec.metadata["changelog_uri"] = "https://github.com/jpsilvashy/ruby-superparser/blob/main/CHANGELOG.md"
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?: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 "example-gem", "~> 1.0"
+  spec.add_development_dependency 'rails', '>= 6.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/ruby/superparser.rbs

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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: ruby-superparser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JP Silvashy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: The Ruby Superparser gem simplifies making HTTP requests to the SuperParser
+  API for parsing resume documents.
+email:
+- jpsilvashy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/ruby_superparser/install_generator.rb
+- lib/generators/ruby_superparser/templates/initializer.rb
+- lib/ruby/superparser.rb
+- lib/ruby/superparser/version.rb
+- ruby-superparser.gemspec
+- sig/ruby/superparser.rbs
+homepage: https://github.com/jpsilvashy/ruby-superparser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jpsilvashy/ruby-superparser
+  source_code_uri: https://github.com/jpsilvashy/ruby-superparser
+  changelog_uri: https://github.com/jpsilvashy/ruby-superparser/blob/main/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.2.33
+signing_key:
+specification_version: 4
+summary: A Ruby client for the SuperParser API
+test_files: []