bigstock-client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c96c21930404e63612b29c63fe70c30c0fccc494
+  data.tar.gz: 9679729e2a07638b2baf51329b64cb3561084856
+SHA512:
+  metadata.gz: 93dfae45a0e096ed72193e13c084b2c1886426bf7d15b80d980396c4648fc64c6d3720c0f457d13ddd7b051c5616a104ab3fffdcb5f0774ec5d57723459374c2
+  data.tar.gz: be0f903fa18b6f6e0b4a41f4e0e8968885e378988a5cca42f5c281b3a54a1b59ab22f6e4dd29bbbde4cd7770f9b2175ca29a56aa50d9216277dbc0c94d0bbcea

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'json', '~>1.8'
+gem 'httparty', '~>0.13'
+

data/Gemfile.lock

@@ -0,0 +1,17 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    hashie (3.3.2)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.1)
+    multi_xml (0.5.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hashie (~> 3.3)
+  httparty (~> 0.13)
+  json (~> 1.8)

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 moiesk
+
+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,90 @@
+# bigstock-client-ruby
+
+A Ruby client for Bigstock's API
+
+## Installation
+
+Bigstock-Client-Ruby is available as a RubyGem:
+
+```bash
+$ gem install bigstock-client
+```
+
+## Usage
+
+Create an instance of the Bigstock API Client by passing in your API ID
+and API Secret as parameters. The client will then handle any authentication
+when required.
+
+```ruby
+require 'bigstock/client'
+client = Bigstock::Client::Client.new('API_ID', 'API_SECRET')
+```
+
+Then use the client to contact the Bigstock-API
+
+### Search
+```ruby
+response = client.search('dog')
+if response['message'] == 'success'
+  pages = response['data']['pages']
+  images = response['data']['images']
+end
+```
+
+Additional options might be passed to the `search`. For a list of
+options see [Bigstock's API
+documentatation](http://help.bigstockphoto.com/hc/en-us/articles/200303245-API-Documentation#search)
+
+For example, to get only the first five images for 'dog' but
+with all image details:
+```ruby
+response = client.search('dog', response_detail: 'all', limit: 5)
+```
+
+### Image Detail
+
+The image ID returned in a search response can be used to query for more
+information about a specific image.
+```ruby
+response = client.image('IMAGE_ID')
+if response['message'] == 'success'
+  image = response['data']['image']
+end
+```
+
+### Purchase
+
+Once you have funded your API account you will be able to download full
+resolution un-watermarked images.
+```ruby
+response = client.purchase('IMAGE_ID', 'SIZE_CODE')
+if response['message'] == 'success'
+  download_url = client.get_download_url(response['data']['download_id'])
+end
+```
+
+### Lightboxes & Saved Images
+
+To get the list of private lightbox content saved under your account:
+
+```ruby
+response = client.lightboxes
+if response['message'] == 'success'
+  total_items = response['data']['total_items']
+  lightboxes = response['data']['lightboxes']
+end
+```
+
+To get the content of a lightbox
+
+```ruby
+response = client.lightbox('LIGHTBOX_ID')
+if response['message'] == 'success'
+  pages = response['data']['pages']
+  lightbox = response['data']['lightbox']
+  images = response['data']['images']
+end
+```
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bigstock-client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bigstock/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bigstock-client"
+  spec.version       = Bigstock::Client::VERSION
+  spec.authors       = ["Moises Eskinazi"]
+  spec.email         = ["meskinazi@shutterstock.com"]
+  spec.summary       = %q{A ruby client for Bigstock's API}
+  spec.description   = %q{A simple ruby library to access Bigstock's API. Bigstock is an easy-to-use marketplace for stock images}
+  spec.homepage      = "http://rubygems.org/gems/bigstock-client"
+  spec.license       = "MIT"
+
+  # This will only work with ruby 2.1 or greater
+  spec.required_ruby_version = '~> 2.1'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/bigstock/client.rb

@@ -0,0 +1,76 @@
+require 'bigstock/client/version'
+require 'httparty'
+require 'json'
+require 'digest/sha1'
+
+module Bigstock
+  module Client
+    class Client
+      include HTTParty
+      format :json
+
+      API_VERSION = 2
+
+      def initialize(account_id, secret, use_ssl: false, use_test_api: false)
+        @account_id = account_id
+        @secret = secret
+        protocol = use_ssl ? 'https' : 'http'
+        subdomain = use_test_api ? 'testapi' : 'api'
+        self.class.base_uri "#{protocol}://#{subdomain}.bigstockphoto.com/#{API_VERSION}/#{@account_id}"
+      end
+
+      def search(query, options = {})
+        args = {query: {q: query}}
+        args[:query] = args[:query].merge(options) unless options.empty?
+        self.class.get('/search', args).parsed_response
+      end
+
+      def asset(asset_id, asset_type)
+        self.class.get("/#{asset_type}/#{asset_id}").parsed_response
+      end
+
+      def image(image_id)
+        asset(image_id, 'image')
+      end
+
+      def video(video_id)
+        asset(video_id, 'video')
+      end
+
+      def collections
+        self.class.get('/lightbox', query: { auth_key: get_auth }).parsed_response
+      end
+
+      def collection(collection_id)
+        self.class.get("/lightbox/#{collection_id}", query: { auth_key: get_auth(collection_id) }).parsed_response
+      end
+
+      alias_method :lightboxes, :collections
+
+      alias_method :lightbox, :collection
+
+      def purchase(asset_id, size_code)
+        self.class.get('/purchase', query: { image_id: asset_id, size_code: size_code, auth_key: get_auth(asset_id) }).parsed_response
+      end
+
+      def get_download_url(download_id)
+        [
+            self.class.base_uri,
+            '/download?',
+            "download_id=#{download_id}",
+            "&auth_key=#{get_auth(download_id)}"
+        ].join
+      end
+
+      private
+
+      def get_auth(additional_params = [])
+        elements = [@secret, @account_id].concat(Array(additional_params))
+        Digest::SHA1.hexdigest(elements.join)
+      end
+
+    end
+
+  end
+
+end

data/lib/bigstock/client/version.rb

@@ -0,0 +1,5 @@
+module Bigstock
+  module Client
+    VERSION = "0.0.2"
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: bigstock-client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Moises Eskinazi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: A simple ruby library to access Bigstock's API. Bigstock is an easy-to-use
+  marketplace for stock images
+email:
+- meskinazi@shutterstock.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bigstock-client.gemspec
+- lib/bigstock/client.rb
+- lib/bigstock/client/version.rb
+homepage: http://rubygems.org/gems/bigstock-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby client for Bigstock's API
+test_files: []