metallica_logo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b9dd2594b61bf96029f0752f269a955a28dc2ea8d1867b62a9e03d42c7ef286
+  data.tar.gz: 99c9bc0e8a2534ba03cd3c2891a27ad8f65b6347b684613f2fa7d369caee6f0f
+SHA512:
+  metadata.gz: 2f233c55773d5d78cfd44d870bbcce6f0ea6b08d1a31829122ddeea316117bbce9bf3b7b3c7c1a81efbdbd6a598fa7f3c4c0e419e188763edc8c2904ffc4d1ec
+  data.tar.gz: 908f05a5ddb7bc93ceb15f495684351a9d30c09df6f9e534e8e08465552e2868fa6a33cc29a39935d09e842e64ced8cb044c7e83bce4b845055086095f3d92f8

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in metallica_logo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    metallica_logo (0.0.1)
+      rest-client (~> 2.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)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.11.3)
+    minitest-spec-context (0.0.4)
+    netrc (0.11.0)
+    public_suffix (4.0.3)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    safe_yaml (1.0.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    vcr (5.0.0)
+    webmock (3.8.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  metallica_logo!
+  minitest (~> 5.0)
+  minitest-spec-context (~> 0.0.3)
+  rake (~> 10.0)
+  vcr (~> 5.0)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 john_farrell
+
+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,59 @@
+# MetallicaLogo
+
+![Metallica Logo](https://raw.githubusercontent.com/johnmfarrell1/metallica_logo/master/examples/metallica_logo_example_cropped.png)
+
+Get any provided text as a Metallica image logo.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'metallica_logo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install metallica_logo
+
+## Usage
+
+You can initialize a new client for fetching logos as follows:
+```ruby
+client = MetallicaLogo::Client.new
+```
+
+The client has 2 public methods depending on how you wish to use it.
+To fetch a logo result without downloading the image, use the following:
+
+```ruby
+logo = client.generate_logo('some test to generate')
+#=> #<MetallicaLogo::Result:0x0000000000000000 @file="<url to image>", @token="token", @result="result">
+```
+
+If you wish to also save the image locally, use the following:
+
+```ruby
+logo = client.generate_and_download_logo('some test to generate', 'file.jpg')
+#=> #<Pathname:file.jpg>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+Note: This gem uses a 3rd party API. I do not own this 3rd party API.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johnmfarrell1/metallica_logo.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'metallica_logo'
+
+# 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/metallica_logo.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'metallica_logo/version'
+require 'metallica_logo/result'
+require 'metallica_logo/client'
+require 'rest-client'
+require 'json'
+require 'pathname'
+
+module MetallicaLogo
+  class Error < StandardError; end
+  class ServerError < Error; end
+  class RequestError < Error; end
+
+  BASE_URL = 'http://metallica.alwaysdata.net'
+end

data/lib/metallica_logo/client.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MetallicaLogo
+  # HTTP client for requesting logo generation and also
+  # if desired, downloading to a local destination
+  class Client
+    attr_reader :rest_klass, :base_url
+
+    MAX_CHARACTERS = 25
+
+    def initialize(base_url: MetallicaLogo::BASE_URL, rest_klass: RestClient)
+      @rest_klass = rest_klass
+      @base_url = base_url
+    end
+
+    def generate_logo(text)
+      if text.size > MAX_CHARACTERS
+        raise RequestError, "Too many characters, limit is #{MAX_CHARACTERS}"
+      end
+
+      response = post("#{@base_url}/creation/", 'the_text': text)
+      MetallicaLogo::Result.new(JSON.parse(response))
+    end
+
+    def generate_and_download_logo(text, destination_file)
+      result = generate_logo(text)
+      destination_file = Pathname(destination_file)
+      destination_file.dirname.mkpath
+      response = download(result.file)
+      IO.binwrite(destination_file, response.body)
+      destination_file
+    end
+
+    private
+
+    def download(url)
+      rest_klass.get(url)
+    rescue rest_klass::ExceptionWithResponse => e
+      validate_response(e.response)
+    end
+
+    def post(url, payload)
+      response = rest_klass.post(url, payload)
+      validate_response(response)
+    rescue rest_klass::ExceptionWithResponse => e
+      validate_response(e.response)
+    end
+
+    def validate_response(response)
+      unless valid_json?(response.body)
+        raise ServerError, 'Invalid JSON returned'
+      end
+
+      case response.code.to_s
+      when /2\d\d/ then response
+      when /5\d\d/ then raise ServerError, response.body
+      else
+        raise RequestError, response.body
+      end
+    end
+
+    def valid_json?(value)
+      result = JSON.parse(value)
+      result.is_a?(Hash)
+    rescue JSON::ParserError
+      false
+    end
+  end
+end

data/lib/metallica_logo/result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MetallicaLogo
+  # value object for storing the response of a logo
+  # generation request
+  class Result
+    attr_reader :file, :token, :result
+
+    def initialize(data)
+      @file = "#{MetallicaLogo::BASE_URL}/#{data['file']}"
+      @token = data['token']
+      @result = data['result']
+    end
+  end
+end

data/lib/metallica_logo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MetallicaLogo
+  VERSION = '0.0.1'
+end

data/metallica_logo.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metallica_logo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'metallica_logo'
+  spec.version       = MetallicaLogo::VERSION
+  spec.authors       = ['john_farrell']
+  spec.email         = ['john_farrell@symantec.com']
+
+  spec.summary       = 'Small gem for generating a Metallica '\
+                       'like logo for some provided string'
+  spec.description   = 'This gem uses an existing logo generation API '\
+                       'to generate a Metallica like logo for a given string'
+  spec.homepage      = 'https://github.com/johnmfarrell1'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/johnmfarrell1/metallica_logo'
+    spec.metadata['changelog_uri'] = 'https://github.com/johnmfarrell1/metallica_logo'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'vcr', '~> 5.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_dependency 'rest-client', '~> 2.0'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: metallica_logo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- john_farrell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-31 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem uses an existing logo generation API to generate a Metallica
+  like logo for a given string
+email:
+- john_farrell@symantec.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/metallica_logo_example.jpg
+- examples/metallica_logo_example_cropped.png
+- lib/metallica_logo.rb
+- lib/metallica_logo/client.rb
+- lib/metallica_logo/result.rb
+- lib/metallica_logo/version.rb
+- metallica_logo.gemspec
+homepage: https://github.com/johnmfarrell1
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/johnmfarrell1
+  source_code_uri: https://github.com/johnmfarrell1/metallica_logo
+  changelog_uri: https://github.com/johnmfarrell1/metallica_logo
+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: Small gem for generating a Metallica like logo for some provided string
+test_files: []