shutterstock-v2 0.0.1

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+task :default => :spec
+task :test => :spec
+
+desc "Run spec tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--color"
+end
+
+desc 'Run RuboCop on the lib directory'
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['progress']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/lib/client/auth.rb

@@ -0,0 +1,48 @@
+module Shutterstock
+	class Auth < Driver
+
+    def self.get_authorize_url(redirect_uri:, scope:, state: 'state_%d' % [Time.now.to_i])
+      resp = client.request do |r|
+        r.path            "/v2/oauth/authorize"
+        r.method          :get
+        r.send_authorization  false
+        r.success_status  302
+        r.params          ({ scope: scope,
+                             client_id: client.config.client_id,
+                             response_type: 'code',
+                             state: state,
+                             redirect_uri: redirect_uri })
+      end
+      redirect_location = resp.headers[:location]
+      returned_state = ensure_next_url_contains_sent_state(redirect_location, state)
+
+      redirect_location
+    end
+
+    def self.get_access_token(code:, grant_type: 'authorization_code', contributor: 'customer')
+      resp = client.request do |r|
+        r.path            "/v2/oauth/access_token"
+        r.method          :post
+        r.send_authorization  false
+        r.content_type    'application/x-www-form-urlencoded'
+        r.body            ({ grant_type: grant_type,
+                             client_id: client.config.client_id,
+                             client_secret: client.config.client_secret,
+                             code: code,
+                             contributor: contributor })
+		  end
+      resp.body
+    end
+
+    private
+
+    def self.ensure_next_url_contains_sent_state(url, state)
+      # https://accounts.shutterstock.com/login?next=%2Foauth%2Fauthorize%3Fclient_id%3D<SSTK_CLIENT_ID...
+      next_query = CGI.parse(URI.parse(url).query)["next"].first
+      # /oauth/authorize?client_id=<SSTK_CLIENT_ID>&redirect_uri=...
+      returned_state = CGI.parse(URI.parse(next_query).query)["state"].first
+      raise(RuntimeError, "State in redirected url (%s) not identical to sent state (%s)" % [returned_state,state]) unless (returned_state==state)
+    end
+
+	end
+end

data/lib/client/categories.rb

@@ -0,0 +1,11 @@
+module Shutterstock
+	class Categories < Array
+		attr_reader :raw_data
+		def initialize(raw_data)
+			@raw_data = raw_data
+  		super( @raw_data.map{ |cat| Category.new(cat) } )
+			self
+		end
+
+	end
+end

data/lib/client/category.rb

@@ -0,0 +1,16 @@
+module Shutterstock
+	class Category < Driver
+		attr_reader :id, :name
+
+    include Equalizer.new(:id)
+
+		def initialize(params={})
+			@hash         = params
+      @id           = params["id"].to_i
+			@name           = params["name"]
+		end
+
+    # TODO API calls
+
+	end
+end

data/lib/client/client.rb

@@ -0,0 +1,72 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'singleton'
+
+module Shutterstock
+
+  class Client
+    include Singleton
+
+    # @return [Configuration] Config instance
+    attr_reader :config
+
+    # Request options
+    attr_accessor :options
+
+    # Creates a new {Client} instance and yields {#config}.
+    # Requires a block to be given.
+    def configure
+      raise AppNotConfigured, "block not given" unless block_given?
+
+      @config = Configuration.new
+      yield config
+
+      @config.api_url ||= "https://api.shutterstock.com/v2"
+      raise AppNotConfigured, "Client ID not provided" if config.client_id.nil?
+      raise AppNotConfigured, "Client Secret not provided" if config.client_secret.nil?
+      # raise AppNotConfigured, "Access Token not provided" if config.access_token.nil? # Not needed for auth requests
+
+      @options = {
+        base_uri: config.api_url,
+        client_id: config.client_id,
+        client_secret: config.client_secret,
+        access_token: config.access_token
+      }
+
+    end
+
+    def configured?
+      !config.nil?
+    end
+
+    def connection
+      @connection ||= Faraday.new(config.api_url) do |conn|
+        conn.response :json, content_type: /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(&block)
+      req = Request.new(&block)
+      api(req)
+    end
+
+    def api(request)
+
+      raise AppNotConfigured, "Access Token not provided" if options[:access_token].nil? && request.send_authorization
+
+      content_type = request.content_type
+      response = connection.run_request(request.method, nil, nil, nil) do |req|
+        req.url request.path
+        req.headers['Authorization'] = 'Bearer '+options[:access_token] if request.send_authorization
+        req.headers['Content-Type'] = request.content_type
+        req.params = request.params if request.params
+        req.body = (content_type =~ /json/ ? request.body.to_json : URI.encode_www_form(request.body)) if request.body
+      end
+      raise FailedResponse.new("Something went wrong: #{response.status}: #{response.body}", response.status) unless (response.status == request.success_status)
+      response
+    end
+
+  end
+end

data/lib/client/collection.rb

@@ -0,0 +1,151 @@
+module Shutterstock
+	class Collection < Driver
+		attr_reader :id, :name, :share_url, :share_code, :total_count, :created, :updated, :items_updated, :cover_item, :hash
+
+    include Equalizer.new(:id)
+
+		def initialize(params={})
+			@hash         = params
+			@id           = params["id"].to_i
+			@name         = params["name"]
+      @share_code   = params["share_code"]
+			@share_url    = params["share_url"]
+      @total_count  = params["total_item_count"].to_i
+      @created      = to_date(params["created_time"])
+      @updated      = to_date(params["updated_time"])
+      @items_updated = to_date(params["items_updated_time"])
+      @cover_item   = Image.new(params["cover_item"]) if params["cover_item"]
+		end
+
+		def self.find(id)
+      resp = client.request do
+        path "/v2/images/collections/#{id}"
+        method :get
+      end
+      self.new(resp.body)
+		end
+
+		def find
+			self.class.find(self.id)
+		end
+
+    def self.create(name)
+      raise IncorrectArguments, "collection name not provided" unless name
+
+      resp = client.request do |r|
+        r.path            "/v2/images/collections"
+        r.method          :post
+        r.body            ({ name: name })
+        r.success_status  201
+      end
+
+      resp_hash = resp.body
+      resp_hash.merge!("name" => name)
+      self.new(resp_hash)
+    end
+
+		def self.list
+      resp = client.request do
+        path            "/v2/images/collections"
+        method          :get
+      end
+      Collections.new(resp.body)
+		end
+
+		def self.update(id:, name:)
+			raise IncorrectArguments, "collection name not provided" unless name
+
+      resp = client.request do |r|
+        r.path            "/v2/images/collections/#{id}"
+        r.method          :post
+        r.body            ({ name: name })
+        r.success_status  204
+      end
+    end
+
+    def self.destroy(id)
+      resp = client.request do |r|
+        r.path            "/v2/images/collections/#{id}"
+        r.method          :delete
+        r.success_status  204
+      end
+      nil
+    end
+
+    def destroy
+      self.class.destroy(self.id)
+		end
+
+		# collection.add_image({collection_id: 1234556, image_id: 98765432})
+		def self.add_image(id:, image_id:)
+
+			raise IncorrectArguments, "collection id not provided" unless id
+			raise IncorrectArguments, "image id not provided" unless image_id
+
+      resp = client.request do |r|
+        r.path            "/v2/images/collections/#{id}/items"
+        r.method          :post
+        r.body            ({ items: image_ids_to_array_of_hash(image_id)})
+        r.success_status  204
+      end
+      self
+    end
+
+    # image_id can be a single or array of either image ids or Image objects
+    def add_image(image_id)
+      self.class.add_image({id: self.id, image_id: image_id})
+    end
+
+    def self.remove_image(id:, image_id:)
+
+      resp = client.request do |r|
+        r.path            "/v2/images/collections/#{id}/items"
+        r.method          :delete
+        r.params          image_ids_to_hash_of_array(image_id)
+        r.success_status  204
+      end
+      self
+		end
+
+		def remove_image(image_id)
+			self.class.remove_image(id: self.id, image_id: image_id)
+		end
+
+    def self.items(id)
+      raise IncorrectArguments, "collection id not provided" unless id
+
+      resp = client.request do |r|
+        r.path            "/v2/images/collections/#{id}/items"
+        r.method          :get
+      end
+      Images.new(resp.body["data"])
+    end
+
+    def items
+      self.class.items(self.id)
+    end
+
+
+
+    private
+
+    # for post request
+    # image_id from [1,2,Image.new("id" => 3)] => [{id: "1"},{id: "2"},{id: "3"}]
+    # from 1 => [{id: "1"}]
+    # from Image.new("id" => 1) => [{id: "1"}]
+    def self.image_ids_to_array_of_hash(image_ids)
+      Array(image_ids).map{|iid| { id: (iid.is_a?(Image) ? iid.id : iid).to_s} }
+    end
+    # for delete request
+    # image_id from [1,2,Image.new("id" => 3)] => {id: [1,2,3]}
+    # from 1 => {id: 1}
+    # from Image.new("id" => 1) => {id: 1}
+    def self.image_ids_to_hash_of_array(image_ids)
+      if image_ids.is_a? Array
+        {id: image_ids.map{|iid| iid.is_a?(Image) ? iid.id : iid}}
+      else
+        {id: image_ids.is_a?(Image) ? image_ids.id : image_ids}
+      end
+    end
+	end
+end

data/lib/client/collections.rb

@@ -0,0 +1,16 @@
+module Shutterstock
+	class Collections < Array
+		attr_reader :raw_data
+		def initialize(raw_data)
+			@raw_data = raw_data
+
+			if raw_data.kind_of? Hash
+				super(@raw_data["data"].map{ |collection| Collection.new(collection) })
+			elsif raw_data.kind_of? Array
+				super( @raw_data.map{ |collection| Collection.new(collection) } )
+			end
+
+			self
+		end
+	end
+end

data/lib/client/configuration.rb

@@ -0,0 +1,20 @@
+module Shutterstock
+	class Configuration
+		# @return [String] The client id.
+		attr_accessor :client_id
+
+		# @return [String] The client secret.
+		attr_accessor :client_secret
+
+		# @return [String] The access token.
+		attr_accessor :access_token
+
+		# @return [String] The API url.
+		attr_accessor :api_url
+
+		def initialize
+			@client_options = {}
+		end
+
+	end
+end

data/lib/client/contributor.rb

@@ -0,0 +1,15 @@
+module Shutterstock
+	class Contributor < Driver
+		attr_reader :id
+
+    include Equalizer.new(:id)
+
+		def initialize(params={})
+			@hash         = params
+			@id           = params["id"].to_i
+		end
+
+    # TODO API calls
+
+	end
+end

data/lib/client/driver.rb

@@ -0,0 +1,38 @@
+require 'date'
+
+module Shutterstock
+	class Driver
+
+		def respond_to(method)
+			return true if @hash[method.to_s]
+			super()
+		end
+
+		def methods
+			methods = super()
+			[methods, @hash.keys.map{ |k| k.to_sym} ].flatten
+		end
+
+		TRUTHY_JSON_VALUES = [ "1", 1, true, "true"]
+		def json_true?(thing)
+			TRUTHY_JSON_VALUES.include? thing
+		end
+
+    def to_date(text_date)
+      return nil if text_date.nil?
+      DateTime.parse(text_date)
+    end
+
+		def client
+			Client.instance
+		end
+
+		def self.client
+			Client.instance
+		end
+
+    def self.api(*params)
+      client.api(*params)
+    end
+	end
+end

data/lib/client/error.rb

@@ -0,0 +1,20 @@
+module Shutterstock
+  class Error < StandardError
+  end
+
+  class IncorrectArguments < Error
+  end
+
+  class AppNotConfigured < Error
+  end
+
+  class FailedResponse < Error
+    attr_reader :code
+    alias :msg :message
+    def initialize(msg, code = 0)
+      @code = code
+      super(msg)
+    end
+  end
+
+end

data/lib/client/image.rb

@@ -0,0 +1,139 @@
+module Shutterstock
+	class Image < Driver
+    attr_reader :hash, :id, :description, :added, :media_type, :contributor, :aspect, :image_type, :is_editorial,
+                :is_adult, :is_illustration, :has_model_release, :has_property_release, :model_releases, :categories,
+                :keywords, :assets, :models
+
+    include Equalizer.new(:id)
+
+# {"id":"118139110",
+#   "added_date":"2012-11-09",
+#   "aspect":1.5,
+#   "assets":{"small_jpg":{"display_name":"Small","dpi":72,"file_size":88064,"format":"jpg","height":333,"is_licensable":true,"width":500},
+#             "medium_jpg":{"display_name":"Med","dpi":300,"file_size":301056,"format":"jpg","height":667,"is_licensable":true,"width":1000},
+#             "huge_jpg":{"display_name":"Huge","dpi":300,"file_size":2790400,"format":"jpg","height":3090,"is_licensable":true,"width":4635},
+#             "supersize_jpg":{"display_name":"Super","dpi":300,"file_size":10112609,"format":"jpg","height":6180,"is_licensable":false,"width":9270},
+#             "huge_tiff":{"display_name":"Huge","dpi":300,"file_size":42966450,"format":"tiff","height":3090,"is_licensable":false,"width":4635},
+#             "supersize_tiff":{"display_name":"Super","dpi":300,"file_size":171865800,"format":"tiff","height":6180,"is_licensable":false,"width":9270},
+#             "preview":{"height":300,"url":"https://image.shutterstock.com/display_pic_with_logo/1306729/118139110/stock-photo-adorable-labrador-puppy-playing-with-a-chew-toy-on-white-backdrop-118139110.jpg","width":450},
+#             "small_thumb":{"height":67,"url":"https://thumb1.shutterstock.com/thumb_small/1306729/118139110/stock-photo-adorable-labrador-puppy-playing-with-a-chew-toy-on-white-backdrop-118139110.jpg","width":100},
+#             "large_thumb":{"height":100,"url":"https://thumb1.shutterstock.com/thumb_large/1306729/118139110/stock-photo-adorable-labrador-puppy-playing-with-a-chew-toy-on-white-backdrop-118139110.jpg","width":150}
+#             },
+#   "categories":[{"id":"1","name":"Animals/Wildlife"},{"id":"20","name":"NOT-CATEGORIZED"}],
+#   "contributor":{"id":"1306729"},
+#   "description":"Adorable Labrador Puppy Playing with a Chew Toy on White Backdrop",
+#   "image_type":"photo",
+#   "is_adult":false,
+#   "keywords":["animal","animal themes","backgrounds","cute","dog","domestic animals","friendship","full length","isolated"],
+#   "media_type":"image"}
+
+		def initialize(params = {})
+      load_ivars(params)
+		end
+
+    def load_ivars(params)
+      @hash                       = params
+      @id                         = params["id"].to_i
+      @description                = params["description"]
+      @added                      = to_date(params["added_date"])
+      @media_type                 = params["media_type"]
+      @contributor                = Contributor.new(params["contributor"]) if params["contributor"]
+      @aspect                     = params["aspect"]
+      @image_type                 = params["image_type"]
+      @is_editorial               = json_true? params["is_editorial"]
+      @is_adult                   = json_true? params["is_adult"]
+      @is_illustration            = json_true? params["is_illustration"]
+      @has_model_release          = json_true? params["has_model_release"]
+      @has_property_release       = json_true? params["has_property_release"]
+      @model_releases             = params["model_releases"]
+      @categories                 = Categories.new(params["categories"]) if params["categories"]
+      @keywords                   = params["keywords"]
+      @assets                     = ImageAssets.new(params["assets"]) if params["assets"]
+      @models                     = Models.new(params["models"]) if params["models"]
+    end
+
+		# boolean readers
+    def editorial?
+      @is_editorial
+    end
+
+    def adult?
+      @is_adult
+    end
+
+    def illustration?
+      @is_illustration
+    end
+
+    def model_release?
+      @has_model_release
+    end
+
+    def property_release?
+      @has_property_release
+    end
+
+
+
+		def self.find(id)
+      resp = client.request do |r|
+        r.path            "/v2/images/#{id}"
+        r.method          :get
+      end
+			self.new(resp.body)
+		end
+
+		def find
+			self.class.find(self.id)
+		end
+
+		def self.similar(id)
+      resp = client.request do |r|
+        r.path            "/v2/images/#{id}/similar"
+        r.method          :get
+      end
+			Images.new(resp.body)
+		end
+
+		def similar
+			@images = self.class.similar(self.id)
+		end
+
+    def self.search(search)
+      search_params = {}
+      if search.kind_of? String
+        search_params[:query] = search
+      else
+        search_params = search
+      end
+
+      resp = client.request do |r|
+        r.path            "/v2/images/search"
+        r.method          :get
+        r.params          search_params
+      end
+      Images.new(resp.body)
+    end
+
+    # Fetch all details of this image
+    def fill
+      load_ivars(find.hash)
+      self
+    end
+
+    # License current image with available subscription
+    def license(format: nil, size: nil)
+      sub = find_subscription_for_this_size(size)
+      License.license(subscription_id: sub.id, image_id: self, format: format, size: size, editorial_acknowledgement: (editorial? ? true : nil))
+    end
+
+    private
+
+    def find_subscription_for_this_size(size = nil)
+      User.subscriptions.find_subscription_for_image_size
+    end
+
+
+
+	end
+end