shutterstock-ruby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee208d1ecc3c46db667ef7bc689ab76952ccb557
-  data.tar.gz: 5b1aaec166ec632891e7715186576717b0862314
+  metadata.gz: 0a95e1ae36a5dd6e7063d5ffc969c65b8ddf3c71
+  data.tar.gz: f98f79dd8b1becabd999cbf4fb505ac0637f08a3
 SHA512:
-  metadata.gz: b99eaded4fc7b274a2867a2bbb502a2486ab478e926a2c4877e343197602d0cb957714096f54c47bef15d386ccd55abd77e12987a2c026f9f8c8a2ec4c50e57d
-  data.tar.gz: 6ef64b682f9596a7d169d2e9eee3758c822ebb1f5b41521275a2de3fbe67bdb7d22c942cd490a9182b7d98c7aabf4165c70f550a1ec440a3dfadfd0a00b5b5fb
+  metadata.gz: 016b42448cdc4e2b2273dbfcab221b5f2589dd90ca48e4244b8b40c36597862e9a859cdc4cb56b0e1bebefb15eda24ed91c5ae221ce8c42435ca23d74e816afd
+  data.tar.gz: ce2ce5016db3367e4bef6d73f538a92e7073f1689e289ff737cc1df04e1e341ad3dd4a6d81b8c6da6a2e21ee2331bd1c98adcac202b16251ab1aad0ab231d979

data/README.md

@@ -30,6 +30,13 @@ ShutterstockRuby.configure do |config|
 end
 ```
 
+If you require multiple clients, you can create an instance:
+```rb
+@client ||= ShutterstockRuby::Client.new(access_token: access_token)
+```
+
+You must supply either an `api_client` and an `api_secret`, or an `access_token`.
+
 ### Search for images
 
 ```rb
@@ -39,11 +46,47 @@ Source [source](https://developers.shutterstock.com/api/v2/images/search)
 
 ### Search for videos
 
+Using the singleton client:
 ```rb
 result = ShutterstockRuby::Videos.search('Cat') # Returns a hash of the parsed JSON result.
 ```
+
+Using an instance of the client:
+```rb
+result = @client.videos.search('Cat') # Returns a hash of the parsed JSON result.
+```
+
 Source [source](https://developers.shutterstock.com/api/v2/videos/search)
 
+### Details for a video
+
+```rb
+result = @client.videos.details(video_id) # Returns a hash of the parsed JSON result.
+```
+Source [source](https://developers.shutterstock.com/api/v2/videos/get)
+
+### Purchase a video
+
+```rb
+result = @client.videos.purchase(video_id, subscription_id, size) # Returns a hash of the parsed JSON result.
+```
+Source [source](https://developers.shutterstock.com/api/v2/videos/license)
+
+### Retrieve an existing license for a video
+
+```rb
+result = @client.videos.licenses(video_id, license_name) # Returns a hash of the parsed JSON result.
+```
+Source [source](https://developers.shutterstock.com/api/v2/videos/licenses)
+
+### Download a video that has already been purchased
+
+```rb
+result = @client.videos.download(license_id) # Returns a hash of the parsed JSON result.
+```
+Source [source](https://developers.shutterstock.com/api/v2/videos/download)
+
+
 ## Disclaimer
 
 This is completely unofficial and is not related to Shutterstock in any way.

data/lib/shutterstock-ruby/videos.rb

@@ -12,10 +12,21 @@ module ShutterstockRuby
 
     def purchase(id, subscription_id, size, options = {})
       params = { subscription_id: subscription_id, size: size }
-      body = { videos: [ video_id: id ] }.to_json
+      metadata = options.delete(:metadata) || {}
+
+      body = { videos: [ { video_id: id }.merge(metadata)] }.to_json
       JSON.parse(post("/videos/licenses", body, params, options))
     end
 
+    def licenses(video_id, license, options = {})
+      params = { video_id: video_id, license: license }
+      JSON.parse(get("/videos/licenses", params.merge(options)))
+    end
+
+    def download(licence)
+      JSON.parse(post("/videos/licenses/#{licence}/downloads", {}.to_json))
+    end
+
     class << self
       def search(query, options = {})
         client.search(query, options)

data/spec/lib/shutterstock_ruby/videos_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+RSpec.describe "ShutterstockRuby Videos API" do
+
+  before do
+    @client = ShutterstockRuby::Client.new.videos
+  end
+
+  it 'can search for videos' do
+    allow(@client).to receive(:get).with("/videos/search", { query: "cats" }).and_return(search_json)
+    expect(@client.search("cats")).to eq(JSON.parse(search_json))
+  end
+
+  it 'can search for videos with options' do
+    allow(@client).to receive(:get).with("/videos/search", { query: "cats", per_page: 10 }).and_return(search_json)
+    expect(@client.search("cats", { per_page: 10 })).to eq(JSON.parse(search_json))
+  end
+
+  it 'can get the details for a video' do
+    allow(@client).to receive(:get).with("/videos", { id: "1234" }).and_return(video_json)
+    expect(@client.details("1234")).to eq(JSON.parse(video_json))
+  end
+
+  it 'can purchase a video' do
+    allow(@client).to receive(:post).with(
+      "/videos/licenses",
+      { videos: [ { video_id: "1234" } ]}.to_json,
+      { subscription_id: "s5678", size: "hd"},
+      {}
+    ).and_return(purchase_json)
+
+    expect(@client.purchase("1234", "s5678", "hd")).to eq(JSON.parse(purchase_json))
+  end
+
+  it 'can purchase a video with metadata and options' do
+    allow(@client).to receive(:post).with(
+        "/videos/licenses",
+        { videos: [ { video_id: "1234", price: 20 } ] }.to_json,
+        { subscription_id: "s5678", size: "hd"},
+        { my_header: "header" }
+    ).and_return(purchase_json)
+
+    expect(@client.purchase("1234", "s5678", "hd", { metadata: { price: 20 }, my_header: "header" })).to eq(JSON.parse(purchase_json))
+  end
+
+  it 'can get an existing license for a video' do
+    allow(@client).to receive(:get).with("/videos/licenses", { video_id: "1234", license: "comp" }).and_return(license_json)
+    expect(@client.licenses("1234", "comp")).to eq(JSON.parse(license_json))
+  end
+
+  it 'can get an download link for an existing license' do
+    allow(@client).to receive(:post).with("/videos/licenses/v5678/downloads", {}.to_json).and_return(download_json)
+    expect(@client.download("v5678")).to eq(JSON.parse(download_json))
+  end
+
+  private
+  def search_json
+    %Q({
+        "page": 1,
+        "per_page": 1,
+        "total_count": 1,
+        "search_id": "abcd",
+        "data": [
+            #{video_json}
+        ]
+    })
+  end
+
+  def purchase_json
+    %q({
+        "data": [
+          {
+            "video_id": "1234",
+            "download": {
+              "url": "http://localhost/1234.mov"
+            },
+            "allotment_charge": 1
+          }
+        ]
+      })
+  end
+
+  def download_json
+    %q({
+        "url": "http://localhost/1234.mov"
+      })
+  end
+
+  def video_json
+    %q({
+        "media_type": "video",
+        "id": "1234",
+        "description": "",
+        "aspect": 1.778,
+        "duration": 26,
+        "contributor": {
+          "id": "1234"
+        },
+        "aspect_ratio": "16:9",
+        "assets": {
+          "thumb_webm": {
+            "url": "http://localhost/1234/cats.webm"
+          },
+          "thumb_mp4": {
+            "url": "http://localhost/1234/cats.mp4"
+          },
+          "preview_webm": {
+            "url": "http://localhost/1234/cats.webm"
+          },
+          "preview_mp4": {
+            "url": "http://localhost/1234/cats.mp4"
+          },
+          "thumb_jpg": {
+            "url": "http://localhost/1234/cats7.jpg"
+          },
+          "preview_jpg": {
+            "url": "http://localhost/1234/cats7.jpg"
+          }
+        }
+      })
+  end
+
+  def license_json
+    %q({
+        "data": [
+          {
+            "id": "v5678",
+            "user": {
+              "username": "user"
+            },
+            "license": "comp",
+            "subscription_id": "s1234",
+            "download_time": "2017-10-09T20:31:04-04:00",
+            "metadata": {
+              "client": "",
+              "other": "",
+              "job": "",
+              "purchase_order": ""
+            },
+            "is_downloadable": true,
+            "video": {
+              "id": "1234",
+              "format": {
+                "size": "hd"
+              }
+            }
+          }
+        ],
+        "page": 1,
+        "per_page": 1
+      })
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shutterstock-ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Nadav Shatz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -86,6 +86,7 @@ files:
 - lib/shutterstock-ruby/connections.rb
 - lib/shutterstock-ruby/images.rb
 - lib/shutterstock-ruby/videos.rb
+- spec/lib/shutterstock_ruby/videos_spec.rb
 - spec/lib/shutterstock_ruby_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/TailorBrands/shutterstock-ruby
@@ -113,5 +114,6 @@ signing_key:
 specification_version: 4
 summary: An API wrapper for the Shutterstock API's
 test_files:
-- spec/lib/shutterstock_ruby_spec.rb
 - spec/spec_helper.rb
+- spec/lib/shutterstock_ruby_spec.rb
+- spec/lib/shutterstock_ruby/videos_spec.rb