share_meow_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cca4a73ae4cd876ae4a0debc8b764936e758dcbc
-  data.tar.gz: 98c1bd0fdce9bbb02acdf3953afa1edab4d7ca62
+  metadata.gz: 0ee9cb013ebb1b59c5cfcf68cc809f739657c83d
+  data.tar.gz: 2bacaa1fd6156ddee765c6856a3f3937bee84fe4
 SHA512:
-  metadata.gz: 5b7cc1143a940e9070518ae10b137d3bc10a13d48f9059dd03c8b0b39de75ebb0cda2bdf0483bf5d5f205f5b384731b9632b079a6838919b69ea5e692e54939d
-  data.tar.gz: e4c78494248af7cfa943d88d178062611c156b464e7f818ad4cdce9c12901e0dd077de0f71b540590c6bc87e829257639ae95819569dd17987d6ec5fc1f89e06
+  metadata.gz: ae9fecc819c44c7febd163adf2a250619484f4966e0d87bbcea7f19232cbd580aa433130ea5809c2dec9f1cdf879a555c5948202ea944180a9ef30bfd060df43
+  data.tar.gz: fb4e404df6babfc91e9332226a576d1c9db52bf2136ae870e8d9d19652d26e529ea15af2c92347da64e78ba2a028b17ae304b60f8233d1892866a751d8e5dbff

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+  Max: 140
+AllCops:
+  Exclude:
+    - 'bin/*'

data/.travis.yml

@@ -1,4 +1,8 @@
 language: ruby
 rvm:
   - 2.2.4
+  - 2.1.8
 before_install: gem install bundler -v 1.10.6
+script:
+  - bundle exec rspec
+  - bundle exec rubocop --config .rubocop.yml

data/README.md

@@ -1,8 +1,9 @@
-# ShareMeowClient
+# ShareMeowClient :heart_eyes_cat:
 
-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/share_meow_client`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby client for easily generating ShareMeow URL's. :star:
+
+Learn more about [ShareMeow](https://github.com/producthunt/ShareMeow).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,20 +23,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, you'll need to set the configuration variables in an initializer.
+
+```Ruby
+# config/initializers/share_meow.rb
+ShareMeowClient.configuration do |config|
+  config.base_url = 'https://your-share-meow.example.com'
+  config.secret_key = 'a_very_long_secret_key'
+end
+```
+
+Then, to generate a URL.
+
+```Ruby
+image_url = ShareMeowClient.image_url(template: 'HelloWorld', options: { message: 'Hi' })
+# => "https://your-share-meow.herokuapp.com/v1/eyJ0ZW1wbGF0ZSI6IkhlbGxvV29ybGQiLCJtZXNzYWdlIjoiSGVsbG8ifQ==/-lgitNQmEs9NaiWyOCHeV137D80=/image.jpg"
+```
+
+`Template` is the name of your ShareMeow template. And then `options` are the required options for your template.
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/share_meow_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/producthunt/ShareMeowCLient. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

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

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "share_meow_client"
+require 'bundler/setup'
+require 'share_meow_client'
 
 # 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.
@@ -10,5 +10,5 @@ require "share_meow_client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/share_meow_client.rb

@@ -4,7 +4,6 @@ require 'openssl'
 require 'share_meow_client/version'
 require 'helpers/configuration'
 
-
 module ShareMeowClient
   extend Configuration
 
@@ -42,6 +41,6 @@ module ShareMeowClient
     hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'.freeze), secret_key, encoded_params)
     hmac_digest = Base64.urlsafe_encode64([hmac].pack('H*'.freeze))
 
-    "#{ base_url }/v1/#{ encoded_params }/#{ hmac_digest }/image.jpg"
+    "#{base_url}/v1/#{encoded_params}/#{hmac_digest}/image.jpg"
   end
 end

data/lib/share_meow_client/version.rb

@@ -1,3 +1,3 @@
 module ShareMeowClient
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/share_meow_client.gemspec

@@ -4,22 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'share_meow_client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "share_meow_client"
+  spec.name          = 'share_meow_client'
   spec.version       = ShareMeowClient::VERSION
-  spec.authors       = ["Mike Coutermarsh"]
-  spec.email         = ["coutermarsh.mike@gmail.com"]
+  spec.authors       = ['Mike Coutermarsh']
+  spec.email         = ['coutermarsh.mike@gmail.com']
 
-  spec.summary       = %q{Ruby client for generating ShareMeow URLs.}
-  spec.description   = %q{Ruby client for generating ShareMeow URLs (https://github.com/producthunt/ShareMeow) }
-  spec.homepage      = "https://github.com/producthunt/ShareMeowClient"
-  spec.license       = "MIT"
+  spec.summary       = 'Ruby client for generating ShareMeow URLs.'
+  spec.description   = 'Ruby client for generating ShareMeow URLs (https://github.com/producthunt/ShareMeow) '
+  spec.homepage      = 'https://github.com/producthunt/ShareMeowClient'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: share_meow_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mike Coutermarsh
@@ -42,16 +42,30 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.35'
 description: 'Ruby client for generating ShareMeow URLs (https://github.com/producthunt/ShareMeow) '
 email:
 - coutermarsh.mike@gmail.com
@@ -61,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile