unsplash_mango 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc5b2262845511e8779726aadf311843c569052cbb2497fba3fe66f5c998a7d9
+  data.tar.gz: 67738b14f3607aa8ee57ba049138595a2d9c2ff9e89d0163b39f0f9bdd6d3d9e
+SHA512:
+  metadata.gz: d313386a50198245e3d2632987cecb03aa573359a3d4dbe41934c9c62009263fd5c8e9f6bd2458d1d2dfcd8b8ad6ef61ef25106174c7d919ded5fe38ab5b11c3
+  data.tar.gz: 8cb31a9a3637789ce68c47091a18ff2b94673f5033b50a12fb99673a499bc5da5c0c92418b5dff42399d1c24b9a75277993a9991f18d795abc0489186f033b88

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+#### Steps to Reproduce
+
+-
+
+#### Observed Behaviour
+
+-
+
+> _Image or video please._
+
+#### Expected Behaviour
+
+-
+
+#### Technical Notes
+
+-

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+#### Overview
+
+-
+- Closes #
+
+#### Todo
+
+-
+
+#### Screenshots/Videos (User Facing Changes)
+
+> _Insert responsive image(s) and/or video(s)_

data/.github/labels.json

@@ -0,0 +1,13 @@
+[
+  { "name": "Priority: Critical", "color": "#e11d21" },
+
+  { "name": "Status: Blocked", "color": "#e11d21" },
+  { "name": "Status: On Hold", "color": "#e11d21" },
+  { "name": "Status: In Progress", "color": "#fbca04" },
+  { "name": "Status: Ready for Review", "color": "#bfe5bf" },
+
+  { "name": "Type: Bug", "color": "#e11d21" },
+  { "name": "Type: Maintenance", "color": "#fbca04" },
+  { "name": "Type: Enhancement", "color": "#84b6eb" },
+  { "name": "Type: Question", "color": "#cc317c" }
+]

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.5
+  - 2.3.1
+  - 2.4.0
+before_install: gem install bundler -v 1.10.2

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+-
+LICENSE.txt
+CODE_OF_CONDUCT.md

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 dev@unsplash.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 unsplash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aaron Klaassen
+
+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,104 @@
+# unsplash_rb
+
+[![Build Status](https://travis-ci.org/unsplash/unsplash_rb.svg?branch=travis)](https://travis-ci.org/unsplash/unsplash_rb)
+[![Coverage Status](https://coveralls.io/repos/github/unsplash/unsplash_rb/badge.svg?branch=master&gh_cache_bust=1)](https://coveralls.io/github/unsplash/unsplash_rb?branch=master)
+
+A ruby client for [the Unsplash API](https://unsplash.com/documentation).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unsplash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unsplash
+
+## Usage
+
+### Configuration
+
+Before making requests, you must configure the gem with your application ID
+and secret. If you are using Rails, you can do this in an initializer.
+
+```ruby
+Unsplash.configure do |config|
+  config.application_access_key = "YOUR ACCESS KEY"
+  config.application_secret = "YOUR APPLICATION SECRET"
+  config.application_redirect_uri = "https://your-application.com/oauth/callback"
+  config.utm_source = "alices_terrific_client_app"
+end
+```
+
+#### API Guidelines
+
+All API applications must abide by the [API Guidelines](https://medium.com/unsplash/unsplash-api-guidelines-28e0216e6daa).
+
+As part of [the API guidelines](https://medium.com/unsplash/unsplash-api-guidelines-28e0216e6daa), all API uses are required to use utm links when providing credit to photographers and Unsplash. Set the `config.utm_source` to your app's name to automatically append the utm source.
+
+### Public-scope actions
+
+If you are *only* making public requests (i.e. nothing requiring a specific logged-in user, for example liking photos or accessing private user details), then you're ready to go!
+
+Looking for details of a specific photo? Find it by ID:
+
+```ruby
+photo = Unsplash::Photo.find("tAKXap853rY")
+```
+
+Want a bunch of pictures of cats? You're on the internet; of course you do.
+
+```ruby
+search_results = Unsplash::Photo.search("cats")
+```
+
+For a complete list of available actions, see our [documentation details](http://www.rubydoc.info/github/unsplash/unsplash_rb/).
+
+### User Authorization
+
+For non-public actions, you'll have to get the user's permission to access their data.
+Direct them to the Unsplash authorization URL:
+
+```ruby
+requested_scopes = ["public", "read_user", "something_else_you_are_asking_for"]
+auth_url = Unsplash::Client.connection.authorization_url(requested_scopes)
+```
+
+Upon authorization, Unsplash will return to you an authentication code via your OAuth
+callback handler. With that you can generate an access token:
+
+```ruby
+Unsplash::Client.connection.authorize!("the authentication code")
+```
+
+And that's it. The API actions will be available to you according to whichever
+permission scopes you requested and the user authorized.
+
+### Hotlinking
+
+Hotlinking the [Unsplash image files is required](https://medium.com/@lukechesser/unsplash-api-guidelines-hotlinking-images-6c6b51030d2a)
+
+Unlike most APIs, Unsplash requires for the image URLs returned by the API to be directly used or embedded in your applications (generally referred to as hotlinking). By using the CDN and embedding the photo URLs in your application, Unsplash can better track photo views and pass those stats on to the photographer, providing them with context for how popular their photo is and how it's being used.
+
+## 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.
+
+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/unsplash/unsplash_rb. 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](http://opensource.org/licenses/MIT).
+

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 "unsplash_mango"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/unsplash/category.rb

@@ -0,0 +1,33 @@
+module Unsplash # :nodoc:
+
+  # Unsplash Category operations.
+  class Category < Client
+
+    class << self
+
+      # Get a list of all of the Unsplash photo categories.
+      # @return [Array] The list categories.
+      # <b>DEPRECATED</b>
+      def all
+        raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
+      end
+
+      # Get an Unsplash Category.
+      # @param id [Integer] The ID of the category to retrieve.
+      # @return [Unsplash::Category] The specified category.
+      # <b>DEPRECATED</b>
+      def find(id)
+        raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
+      end
+    end
+
+    # Get a list of all photos in this category.
+    # @param page  [Integer] Which page of search results to return.
+    # @param per_page [Integer] The number of search results per page. 
+    # @return [Array] A single page of +Unsplash::Photo+s.
+    # <b>DEPRECATED</b>
+    def photos(page = 1, per_page = 10)
+      raise Unsplash::DeprecationError.new "Category has been deprecated and removed."
+    end
+  end
+end

data/lib/unsplash/client.rb

@@ -0,0 +1,57 @@
+module Unsplash # :nodoc:
+
+  # Common functionality across Unsplash API objects.
+  class Client
+
+    # Build an Unsplash object with the given attributes.
+    # @param attrs [Hash]
+    def initialize(attrs = {})
+      @attributes = OpenStruct.new(attrs)
+    end
+
+    # (Re)load full object details from Unsplash.
+    # @return [Unspash::Client] Itself, with full details reloaded.
+    def reload!
+      if links && links["self"]
+        attrs = JSON.parse(connection.get(links["self"]).body)
+        @attributes = OpenStruct.new(attrs)
+        self
+      else
+        raise Unsplash::Error.new "Missing self link for #{self.class} with ID #{self.id}"
+      end
+    end
+
+    # Raw JSON as returned by Unsplash API.
+    # @return [Hash] json
+    def to_h
+      @attributes.to_h
+    end
+
+    # @private
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Client.new(attribute) : attribute
+    end
+
+    # The connection object being used to communicate with Unsplash.
+    # @return [Unsplash::Connection] the connection
+    def connection
+      self.class.connection
+    end
+
+    class << self
+      # The connection object being used to communicate with Unsplash.
+      # @return [Unsplash::Connection] the connection
+      def connection
+        @@connection ||= Connection.new
+      end
+
+      # Assign a default connection object.
+      # @param conn [Unsplash::Connection] the connection
+      # @return [Unsplash::Connection] the connection
+      def connection=(conn)
+        @@connection = conn
+      end
+    end
+  end
+end

data/lib/unsplash/collection.rb

@@ -0,0 +1,152 @@
+module Unsplash # :nodoc:
+
+  # Unsplash Collection operations.
+  class Collection < Client
+
+    class << self
+
+      # Get a specific collection.
+      # @param id [Integer] The ID of the collection.
+      # @return [Unsplash::Collection] The requested collection.
+      def find(id, curated = false)
+        url = ["/collections", (curated ? "curated" : nil), id].compact.join("/")
+        Unsplash::Collection.new JSON.parse(connection.get(url).body)
+      end
+
+      # Get a list of all collections.
+      # @param page [Integer] Which page of search results to return.
+      # @param per_page [Integer] The number of search results per page. (default: 10, maximum: 30)
+      # @return [Array] A single page of the +Unsplash::Collection+ list.
+      def all(page = 1, per_page = 10)
+        params = {
+          page:     page,
+          per_page: per_page
+        }
+        list = JSON.parse(connection.get("/collections/", params).body)
+        list.map { |data| Unsplash::Collection.new(data) }
+      end
+
+
+      # Get a list of all featured collections.
+      # @param page [Integer] Which page of results to return.
+      # @param per_page [Integer] The number of results per page. (default: 10, maximum: 30)
+      # @return [Array] A single page of the +Unsplash::Collection+ list.
+      def featured(page = 1, per_page = 10)
+        params = {
+          page:     page,
+          per_page: per_page
+        }
+        list = JSON.parse(connection.get("/collections/featured", params).body)
+        list.map { |data| Unsplash::Collection.new(data) }
+      end
+
+      # Get a list of all curated collections.
+      # @param page [Integer] Which page of search results to return.
+      # @param per_page [Integer] The number of search results per page. (default: 10, maximum: 30)
+      # @return [Array] A single page of the +Unsplash::Collection+ list.
+      def curated(page = 1, per_page = 10)
+        params = {
+          page:     page,
+          per_page: per_page
+        }
+        list = JSON.parse(connection.get("/collections/curated", params).body)
+        list.map { |data| Unsplash::Collection.new(data) }
+      end
+
+      # Create a new collection on behalf of current user.
+      # @param title [String] The title of the collection.
+      # @param description [String] The collection's description. (optional)
+      # @param private [Boolean] Whether to make the collection private. (optional, default +false+)
+      def create(title: "", description: "", private: false)
+        params = {
+          title:       title,
+          description: description,
+          private:     private
+        }
+        Unsplash::Collection.new JSON.parse(connection.post("/collections", params).body)
+      end
+
+      # Get a single page of collection results for a query.
+      # @param query [String] Keywords to search for.
+      # @param page  [Integer] Which page of search results to return.
+      # @param per_page [Integer] The number of collections search result per page. (default: 10, maximum: 30)
+      # @return [SearchResult] a list of +Unsplash::Collection+ objects.
+      def search(query, page = 1, per_page = 10)
+        params = {
+          query:    query,
+          page:     page,
+          per_page: per_page
+        }
+        Unsplash::Search.search("/search/collections", self, params)
+      end
+
+    end
+
+    def initialize(options = {})
+      options["user"] = Unsplash::User.new options["user"]
+      options["cover_photo"] = Unsplash::Photo.new options["cover_photo"]
+      super(options)
+    end
+
+    # Update the collection's attributes.
+    # @param title [String] The title of the collection.
+    # @param description [String] The collection's description. (optional)
+    # @param private [Boolean] Whether to make the collection private. (optional)
+    def update(title: nil, description: nil, private: nil)
+      params = {
+        title:       title,
+        description: description,
+        private:     private
+      }.select { |k,v| v }
+      updated = JSON.parse(connection.put("/collections/#{id}", params).body)
+      self.title = updated["title"]
+      self.description = updated["description"]
+      self
+    end
+
+    # Delete the collection. This does not delete the photos it contains.
+    # @return [Boolean] +true+ on success.
+    def destroy
+      response = connection.delete("/collections/#{id}")
+      (200..299).include?(response.status)
+    end
+
+    # Get a list of the photos contained in this collection.
+    # @param page [Integer] Which page of photos collection to return.
+    # @param per_page [Integer] The number of photos per page. (default: 10, maximum: 30)
+    # @return [Array] The list of +Unsplash::Photo+s in the collection.
+    def photos(page = 1, per_page = 10)
+      params = {
+        page: page,
+        per_page: per_page
+      }
+
+      list = JSON.parse(connection.get("/collections/#{id}/photos", params).body)
+      list.map { |photo| Unsplash::Photo.new photo }
+    end
+
+    # Add a photo to the collection. If the photo is already in the collection,
+    # this action has no effect.
+    # @param [Unsplash::Photo] The photo to add.
+    # @return [Hash] Collected photo metadata.
+    def add(photo)
+      response = JSON.parse(connection.post("/collections/#{id}/add", { photo_id: photo.id }).body)
+      {
+        photo_id:      response["photo"]["id"],
+        collection_id: response["collection"]["id"],
+        user_id:       response["user"]["id"],
+        created_at:    response["created_at"]
+      }
+    end
+
+    # Remove a photo from the collection. If the photo is not in the collection,
+    # this action has no effect.
+    # @param [Unsplash::Photo] The photo to remove.
+    # @return [Boolean] +true+ on success.
+    def remove(photo)
+      response = connection.delete("/collections/#{id}/remove", photo_id: photo.id)
+      (200..299).include?(response.status)
+    end
+
+  end
+end