html_css_to_image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7cb9fb36816dc78cbc623094d083146344045f0023cb48aa1b46988b33b072e
+  data.tar.gz: ee5058fa957b4fe462790c82e222a4847ea279d579906bf602c0bec8aa882f3e
+SHA512:
+  metadata.gz: c27d9f741cc2a4d34ca12b98a7fecd225a03cbb8db163da9b9c475ee0d7f6b1cdfc570ed64e3321ab330d2793b882e637f5319e5ee268002c20400e269a0545a
+  data.tar.gz: 04a47b6c8b0b03d06e8742c7a19523dcbe117b024d03bef7c6f2bf40bc6511be09ae7606cbd974547d9f8bb28d17bf963fad88bcc5465ec19403e62038d3625e

data/.gitignore

@@ -0,0 +1,63 @@
+*.gem
+*.rbc
+/.bundle/
+/.yardoc
+/_yardoc/
+/.config
+/coverage/
+/doc/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at clayjs0@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    html_css_to_image (0.1.0)
+      faraday (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.5)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    safe_yaml (1.0.5)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  html_css_to_image!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock (~> 3.6)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 jahuty
+
+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,74 @@
+# HtmlCssToImage
+
+A simple SDK for the [HTML/CSS to Image](https://htmlcsstoimage.com) service (HCTI).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html_css_to_image'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install html_css_to_image
+
+## Usage
+
+Set your HCTI `api_key` and `user_id`:
+
+```ruby
+require "html_css_to_image"
+
+HtmlCssToImage.api_key = "a87d7cca-9d66-47d8-aa2c-66bef8583fc9"
+HtmlCssToImage.user_id = "6ee431f7-05e5-43ca-8e28-3160117d29f3"
+```
+
+To create an image, pass `html` and/or `css` arguments to the `create` method. The method will return an `HtmlCssToImage::Data::Image` object with `url` and `id` methods:
+
+```ruby
+html = "<h1>Hello world</h1>"
+css  = "h1 { color: red; }"
+
+image = HtmlCssToImage.create(html: html, css: css)
+
+image.url  
+# => "https://hcti.io/v1/image/bde7d5bf-f7bb-49d9-b931-74e5512b8738"
+image.id
+# => "bde7d5bf-f7bb-49d9-b931-74e5512b8738"
+```
+
+If the API returns any status code except `201`, a `HtmlCssToImage::Error` will be raised with more information about the error.
+
+To delete an image, pass the image's `id` to the `delete` method:
+
+```ruby
+id = "bde7d5bf-f7bb-49d9-b931-74e5512b8738"
+
+HtmlCssToImage.delete(id)
+```
+
+If the API returns any status code except `202` or `404`, a `HtmlCssToImage::Error` will be raised with more information about the error.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `tspec` 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 install`. To release a new version, update the version number in `version.rb`, and then run `bundle 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](https://github.com/jahuty/html_css_to_image). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HtmlCssToImage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/html_css_to_image/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "html_css_to_image"
+
+# 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/html_css_to_image.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "html_css_to_image/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "html_css_to_image"
+  spec.version       = HtmlCssToImage::VERSION
+  spec.authors       = ["Jack Clayton"]
+  spec.email         = ["jack@jahuty.com"]
+
+  spec.summary       = %q{An SDK for the HTML/CSS to Image service}
+  spec.homepage      = "https://htmlcsstoimage.com"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jahuty/html-css-to-image"
+  spec.metadata["changelog_uri"] = "https://github.com/jahuty/html-css-to-image/blob/master/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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.6"
+end

data/lib/html_css_to_image.rb

@@ -0,0 +1,34 @@
+require "html_css_to_image/version"
+
+require "html_css_to_image/image"
+require "html_css_to_image/data/image"
+
+require "faraday"
+
+module HtmlCssToImage
+  class Error < StandardError; end
+
+  API_SCHEME   = "https"
+  API_HOST     = "hcti.io"
+  API_VERSION  = "v1"
+  API_ORIGIN   = "#{API_SCHEME}://#{API_HOST}"
+
+  @api_key
+  @user_id
+
+  class << self
+    attr_writer :api_key, :user_id
+
+    def connection
+      raise "API key not set" if @api_key.nil?
+      raise "User id not set" if @user_id.nil?
+
+      Faraday.new(API_ORIGIN) do |connection|
+        connection.adapter Faraday.default_adapter
+        connection.headers["Content-Type"] = "application/json"
+        connection.headers["Accept"]       = "application/json"
+        connection.basic_auth @user_id, @api_key
+      end
+    end
+  end
+end

data/lib/html_css_to_image/data/image.rb

@@ -0,0 +1,31 @@
+require "uri"
+
+module HtmlCssToImage
+  module Data
+    class Image
+      attr_accessor :url
+
+      def self.from(data)
+        raise ArgumentError.new "Key :url does not exist" unless data.key?(:url)
+
+        Image.new(url: data[:url])
+      end
+
+      def initialize(url:)
+        url = URI(url)
+
+        raise ArgumentError.new "Not https" unless url.scheme == HtmlCssToImage::API_SCHEME
+        raise ArgumentError.new "Not HCTI API" unless url.host == HtmlCssToImage::API_HOST
+
+        @url = url
+      end
+
+      def id
+        url = @url.to_s
+        i   = url.rindex('/') + 1
+
+        url[i..-1]
+      end
+    end
+  end
+end

data/lib/html_css_to_image/image.rb

@@ -0,0 +1,47 @@
+module HtmlCssToImage
+  class Image
+    class << self
+      def create(html: nil, css: nil)
+        raise ArgumentError.new "HTML and CSS are both nil"  if html.nil? && css.nil?
+
+        response = connection.post(resources) do |request|
+          request.body = { html: html.to_s, css: css.to_s }.to_json
+        end
+
+        raise Error.new(
+          "Failed to create image: #{response.status} #{response.body} "
+        ) if response.status != 201
+
+        json = JSON.parse(response.body, symbolize_names: true)
+
+        Data::Image.from(json)
+      end
+
+      def delete(id)
+        raise ArgumentError.new "id is nil" if id.nil?
+
+        response = connection.delete(resource(id))
+
+        raise Error.new(
+          "Failed to delete image #{id}: #{response.status} #{response.body}"
+        ) unless [202, 404].include? response.status
+      end
+
+      private
+
+      def connection
+        @connection ||= HtmlCssToImage.connection
+      end
+
+      private
+
+      def resources
+        "#{HtmlCssToImage::API_VERSION}/image"
+      end
+
+      def resource(id)
+         "/#{resources}/#{id}"
+      end
+    end
+  end
+end

data/lib/html_css_to_image/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: html_css_to_image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Clayton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: 
+email:
+- jack@jahuty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- html_css_to_image.gemspec
+- lib/html_css_to_image.rb
+- lib/html_css_to_image/data/image.rb
+- lib/html_css_to_image/image.rb
+- lib/html_css_to_image/version.rb
+homepage: https://htmlcsstoimage.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://htmlcsstoimage.com
+  source_code_uri: https://github.com/jahuty/html-css-to-image
+  changelog_uri: https://github.com/jahuty/html-css-to-image/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An SDK for the HTML/CSS to Image service
+test_files: []