tinplate 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ab343df2b39b5fab64740c6801bd8be576f5822
-  data.tar.gz: e0c73ac143009fb9f614cdb7820f0d8aeee09e30
+  metadata.gz: 4e28c63b93bf4a54f865668ea7d4119eb39945de
+  data.tar.gz: 0dd7df55fab4b1b0a4c8f6deae490ac81a65b10f
 SHA512:
-  metadata.gz: e3046ddc36bc333a2b5b9caf1ed924c80a368a13d6b8bf78017cb7a55992f3fc71debdfa4d713e836acaea14fb18aa9b6a5fd79b785fcd1917e17bd89dffbd2d
-  data.tar.gz: 868ac2863f91150367d8760083f35df787b47b6f04404a8a98778b37386089b7878bdd2c664228e4352b138828fba15b670f2015873cb1e72c90dc32b6805d9f
+  metadata.gz: 84dd4c2fbf019950ef4bc46a605d18c9a62e5b10f55cd1d19b78df9b4336345b9dd453a686b9786935635444e86bc73213842f6428402e0b73a4158e41d11e27
+  data.tar.gz: 32570d242649e6a0d853905e515c26ecbeac83459b38df47694ba7f19d90bcaa7108abcf585dd3da2261db970d119ceb5ed3206c9897e7303036114977de97c0

data/CODE_OF_CONDUCT.md

@@ -1,13 +1,74 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+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.
 
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+## Our Standards
 
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+Examples of behavior that contributes to creating a positive environment
+include:
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+* 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
 
-This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
+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 [INSERT EMAIL ADDRESS]. 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/README.md

@@ -18,6 +18,21 @@ Or install it yourself as:
 
     $ gem install tinplate
 
+## Configuration
+
+First you've got to let Tinplate know what your TinEye API keys are. In a Rails app, for example, this would go in an initializer, e.g. `config/intitializers/tinplate.rb`:
+
+```ruby
+Tinplate.configure do |config|
+  config.public_key  = "YOUR PUBLIC API KEY"
+  config.private_key = "YOUR PRIVATE API KEY"
+  config.test        = false
+end
+```
+
+If `test` is set to `true` (which is also the default), Tinplate will use [TinEye's test keys and sandbox environment](https://services.tineye.com/developers/tineyeapi/sandbox.html).
+
+
 ## Usage
 
 There are only three API actions available: `search`, `remaining_searches` (to check the status of your account), and `image_count` (if you're curious how many total images TinEye has indexed).
@@ -72,16 +87,16 @@ backlinks:
     }
   ]
 ```
-  
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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 `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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/CrewLabs/tinplate. 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/unsplash/tinplate. 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

data/lib/tinplate/errors.rb

@@ -1,13 +1,20 @@
 module Tinplate
   class Error < StandardError
-    attr_reader :code
-    attr_reader :type
-    attr_reader :message
+    def self.from_response(code, type, message)
+      klass = case message
+              when /503 Service Unavailable/          then Tinplate::ServiceUnavailable
+              when /service is busy due to high load/ then Tinplate::ServiceUnavailable
+              when /Image too simple/                 then Tinplate::NoSignatureError
+              when /purchase another bundle/          then Tinplate::NoCreditsRemaining
+              else
+                Tinplate::Error
+              end
 
-    def initialize(code, type, message)
-      @code = code
-      @type = @type
-      @message = message
+      klass.new(message)
     end
   end
+
+  class ServiceUnvailable < Error; end
+  class NoSignatureError < Error; end
+  class NoCreditsRemaining < Error; end
 end

data/lib/tinplate/tineye.rb

@@ -33,7 +33,7 @@ module Tinplate
       response = ::JSON.parse(connection.get("#{action}/", params).body)
 
       if response["code"] != 200
-        raise Tinplate::Error.new(response["code"], response["messages"][0], response["messages"][1])
+        raise Tinplate::Error.from_response(response["code"], response["messages"][0], response["messages"][1])
       end
 
       response
@@ -42,7 +42,7 @@ module Tinplate
     def connection
       @conn ||= Faraday.new(url: "http://api.tineye.com/rest/") do |faraday|
         faraday.request  :url_encoded
-        faraday.response :logger                
+        faraday.response :logger
         faraday.adapter  Faraday.default_adapter
       end
     end

data/lib/tinplate/version.rb

@@ -1,3 +1,3 @@
 module Tinplate
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 end

data/tinplate.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["aaron@crew.co"]
 
   spec.summary       = %q{A wrapper around the TinEye API.}
-  spec.homepage      = "https://github.com/CrewLabs/tinplate"
+  spec.homepage      = "https://github.com/unsplash/tinplate"
   spec.license       = "MIT"
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinplate
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Aaron Klaassen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -104,7 +104,7 @@ files:
 - lib/tinplate/tineye.rb
 - lib/tinplate/version.rb
 - tinplate.gemspec
-homepage: https://github.com/CrewLabs/tinplate
+homepage: https://github.com/unsplash/tinplate
 licenses:
 - MIT
 metadata: {}