deviantart 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 129907466eb6bebbef69c392e66f9fd291c26d29
-  data.tar.gz: c99998038239822dd3a91a27c9162855d87459c0
+  metadata.gz: '0499ac49ed032c1497d0d60dfbd659f71aef9d2b'
+  data.tar.gz: 5dc456abe5fbab5a9dc470b9f44de697b75822da
 SHA512:
-  metadata.gz: 471b20bcf89d8d7141ed57765b1886f2bce452639b7da88d654e1572b04b4b1e0867192c0cb660c73eaf29f532233afdef5428efa38a3cca37a259868c31615f
-  data.tar.gz: f598852995d20b8ada5eb2fcb32ec33277524f7467db9e28858e7865ca286e134152bce1c7f583321e06a430b5b76afe374e08d0141e0caa4e24aaee68396dd8
+  metadata.gz: 2eb9a19cafdec3e4ca2f72d11c90d81021b86e1175277a15535bdf15a704e6b75eab918d63757229f444833201a74b4e29bea549e33118e99c475f1fc5b332b3
+  data.tar.gz: 85f33e7b9d7a68b1a7fe88b0fa05e44321634f9ce0a70f93b928080183cfdafcc522a5f94164ca9aa37653047f50c00f118c28136ecfa8b3d3ec3fcf34f40a78

data/Gemfile

@@ -8,6 +8,7 @@ group :development do
   gem 'omniauth'
   gem 'omniauth-oauth2', '~> 1.3.1'
   gem 'omniauth-deviantart'
+  gem 'launchy'
 end
 
 # Specify your gem's dependencies in deviantart.gemspec

data/README.md

@@ -7,14 +7,13 @@
 ## Usage
 
 ```ruby
-da = DeviantArt.new do |config|
+da = DeviantArt::Client.new do |config|
   config.client_id = 9999
   config.client_secret = 'LMNOPQRSTUVWXYZZZZZZZZ9999999999'
   # auto refresh access_token with Client Credentials Grant when expired
   config.grant_type = :client_credentials
   config.access_token_auto_refresh = true
 end
-# da is DeviantArt::Client object
 
 deviation = da.get_deviation('F98C2XXX-C6A8-XXXX-08F9-57CCXXXXX187')
 deviation.title # => deviation's title
@@ -92,4 +91,3 @@ The gem is available as open source under the terms of the [MIT License](http://
 ## Badges
 
 [![Build Status](https://travis-ci.org/aycabta/deviantart.svg)](https://travis-ci.org/aycabta/deviantart)
-

data/Rakefile

@@ -2,8 +2,8 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'readline'
 require 'net/http'
+require 'launchy'
 
-BROWSER_COMMAND_FILE = 'test/browser_command'
 AUTHORIZATION_CODE_FILE = 'test/fixtures/authorization_code.json'
 OUTPUT_PIPE = 'test/output_pipe'
 
@@ -15,18 +15,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = test_pettern
 end
 
-def get_browser_command
-  open(BROWSER_COMMAND_FILE, 'r').read
-end
-
-file BROWSER_COMMAND_FILE do
-  browser_command = Readline.readline('Input your browser command> ')
-  open(BROWSER_COMMAND_FILE, 'w') do |f|
-    f.write(browser_command)
-  end
-  puts "Wrote \"#{browser_command}\" to #{BROWSER_COMMAND_FILE}"
-end
-
 def wait_oauth_consumer_booting
   http = Net::HTTP.new('localhost', 4567)
   http.open_timeout = 1
@@ -45,7 +33,7 @@ def wait_oauth_consumer_booting
   end
 end
 
-file AUTHORIZATION_CODE_FILE => BROWSER_COMMAND_FILE do
+file AUTHORIZATION_CODE_FILE do
   if File.exists?(OUTPUT_PIPE)
     File.unlink(OUTPUT_PIPE)
   end
@@ -70,7 +58,7 @@ file AUTHORIZATION_CODE_FILE => BROWSER_COMMAND_FILE do
         cv.wait(mutex)
       end
       puts 'Open browser for authorization'
-      system("#{get_browser_command} http://localhost:4567/auth/deviantart &")
+      Launchy.open('http://localhost:4567/auth/deviantart')
       is_browsed = true
       cv.signal
     }

data/lib/deviantart.rb

@@ -7,6 +7,7 @@ require 'deviantart/status'
 
 module DeviantArt
   # Bypass args and block to DeviantArt::Client
+  # ...for backward compatibility
   def self.new(*args, &block)
     DeviantArt::Client.new(*args, &block)
   end

data/lib/deviantart/authorization_code.rb

@@ -0,0 +1,7 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class AuthorizationCode
+  end
+end
+

data/lib/deviantart/authorization_code/access_token.rb

@@ -0,0 +1,7 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class AuthorizationCode::AccessToken < Base
+    attr_accessor :expires_in, :status, :access_token, :token_type, :refresh_token, :scope
+  end
+end

data/lib/deviantart/authorization_code/refresh_token.rb

@@ -0,0 +1,7 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class AuthorizationCode::RefreshToken < Base
+    attr_accessor :expires_in, :status, :access_token, :token_type, :refresh_token, :scope
+  end
+end

data/lib/deviantart/client.rb

@@ -6,6 +6,11 @@ require 'deviantart/client/data'
 require 'deviantart/client/feed'
 # TODO: comments, cured, messages, notes, stash, util
 require 'deviantart/error'
+require 'deviantart/authorization_code'
+require 'deviantart/authorization_code/access_token'
+require 'deviantart/authorization_code/refresh_token'
+require 'deviantart/client_credentials'
+require 'deviantart/client_credentials/access_token'
 require 'net/http'
 require 'uri'
 require 'json'
@@ -52,8 +57,8 @@ module DeviantArt
     def initialize(options = {})
       @access_token = nil
       @host = @@default_host
-      @on_refresh_access_token = nil
-      @on_refresh_authorization_code = nil
+      @on_refresh_access_token = []
+      @on_refresh_authorization_code = []
       @access_token_auto_refresh = true
       @grant_type = nil
       @headers = {}
@@ -90,71 +95,80 @@ module DeviantArt
         refresh_access_token
         response = request(method, path, params)
       end
-      case response.code
-      when '200'
+      status_code = response.code.to_i
+      case status_code
+      when 200
         klass.new(response.json)
-      when '400'
+      when 400
         # Request failed due to client error,
         # e.g. validation failed or User not found
-        DeviantArt::Error.new(response.json, response.code.to_i)
-      when '401'
+        DeviantArt::Error.new(response.json, status_code)
+      when 401
         # Invalid token
-        DeviantArt::Error.new(response.json, response.code.to_i)
-      when '429'
+        DeviantArt::Error.new(response.json, status_code)
+      when 429
         # Rate limit reached or service overloaded
-        DeviantArt::Error.new(response.json, response.code.to_i)
-      when '500'
+        DeviantArt::Error.new(response.json, status_code)
+      when 500
         # Our servers encountered an internal error, try again
-        DeviantArt::Error.new(response.json, response.code.to_i)
-      when '503'
+        DeviantArt::Error.new(response.json, status_code)
+      when 503
         # Our servers are currently unavailable, try again later.
         # This is normally due to planned or emergency maintenance.
-        DeviantArt::Error.new(response.json, response.code.to_i)
+        DeviantArt::Error.new(response.json, status_code)
       else
-        DeviantArt::Error.new(response.json, response.code.to_i)
+        DeviantArt::Error.new(response.json, status_code)
       end
     end
 
     # Call given block when authorization code is refreshed
     def on_refresh_authorization_code(&block)
-      @on_refresh_authorization_code = block
+      @on_refresh_authorization_code << block
     end
 
     # Call given block when access token is refreshed
     def on_refresh_access_token(&block)
-      @on_refresh_access_token = block
+      @on_refresh_access_token << block
+    end
+
+    def refresh_access_token
+      case @grant_type.to_sym
+      when :authorization_code
+        refresh_authorization_code
+      when :client_credentials
+        refresh_client_credentials
+      end
     end
 
   private
 
     def request(method, path, params = {})
       uri = URI.parse("https://#{@host}#{path}")
+      if params.any?{ |key, value| value.is_a?(Enumerable) }
+        converted_params = []
+        params.each do |key, value|
+          if value.is_a?(Enumerable)
+            value.each_index do |i|
+              converted_params << ["#{key}[#{i}]", value[i]]
+            end
+          else
+            converted_params << [key, value]
+          end
+        end
+        params = converted_params
+      end
       case method
       when :get
         uri.query = URI.encode_www_form(params)
         request = Net::HTTP::Get.new(uri)
       when :post
         request = Net::HTTP::Post.new(uri.path)
-        if params.any?{ |key, value| value.is_a?(Enumerable) }
-          converted_params = []
-          params.each do |key, value|
-            if value.is_a?(Enumerable)
-              value.each_index do |i|
-                converted_params << ["#{key}[#{i}]", value[i]]
-              end
-            else
-              converted_params << [key, value]
-            end
-          end
-          request.body = URI.encode_www_form(converted_params)
-        else
-          request.set_form_data(params)
-        end
+        request.body = URI.encode_www_form(params)
       end
       request['Content-Type'] = 'application/x-www-form-urlencoded'
       request['User-Agent'] = user_agent
       if not @access_token.nil?
-        request["Authorization"] = "Bearer #{@access_token}"
+        request['Authorization'] = "Bearer #{@access_token}"
       end
       @headers.each_pair do |key, value|
         request[key] = value
@@ -174,11 +188,18 @@ module DeviantArt
         :post, '/oauth2/token',
         { grant_type: 'client_credentials', client_id: @client_id, client_secret: @client_secret }
       )
-      if response.code == '200'
+      status_code = response.code.to_i
+      if status_code == 200
         @access_token = response.json['access_token']
-        @on_refresh_access_token.call(@access_token) if @on_refresh_access_token
+        if !@on_refresh_access_token.empty?
+          @on_refresh_access_token.each do |p|
+            p.call(@access_token)
+          end
+        end
+        ClientCredentials::AccessToken.new(response.json)
       else
         @access_token = nil
+        DeviantArt::Error.new(response.json, status_code)
       end
     end
 
@@ -187,21 +208,23 @@ module DeviantArt
         :post, '/oauth2/token',
         { grant_type: 'refresh_token', client_id: @client_id, client_secret: @client_secret, refresh_token: @refresh_token }
       )
-      if response.code == '200'
+      status_code = response.code.to_i
+      if status_code == 200
         @access_token = response.json['access_token']
-        @on_refresh_access_token.call(@access_token) if @on_refresh_access_token
-        @on_refresh_authorization_code.call(@access_token, response.json['refresh_token']) if @on_refresh_authorization_code
+        if !@on_refresh_access_token.empty?
+          @on_refresh_access_token.each do |p|
+            p.call(@access_token)
+          end
+        end
+        if !@on_refresh_authorization_code.empty?
+          @on_refresh_authorization_code.each do |p|
+            p.call(@access_token, response.json['refresh_token'])
+          end
+        end
+        AuthorizationCode::RefreshToken.new(response.json)
       else
         @access_token = nil
-      end
-    end
-
-    def refresh_access_token
-      case @grant_type.to_sym
-      when :authorization_code
-        refresh_authorization_code
-      when :client_credentials
-        refresh_client_credentials
+        DeviantArt::Error.new(response.json, status_code)
       end
     end
   end

data/lib/deviantart/client/deviation.rb

@@ -2,6 +2,8 @@ require 'deviantart/deviation'
 require 'deviantart/deviation/content'
 require 'deviantart/deviation/whofaved'
 require 'deviantart/deviation/download'
+require 'deviantart/deviation/embeddedcontent'
+require 'deviantart/deviation/metadata'
 
 module DeviantArt
   class Client
@@ -16,6 +18,27 @@ module DeviantArt
         perform(DeviantArt::Deviation::Content, :get, '/api/v1/oauth2/deviation/content', { deviationid: deviationid })
       end
 
+      # Fetch content embedded in a deviation.
+      # Journal and literature deviations support embedding of deviations inside them.
+      def get_deviation_embeddedcontent(deviationid, offset_deviationid: nil, offset: 0, limit: 10)
+        params = { deviationid: deviationid }
+        params['offset_deviationid'] = offset_deviationid if offset_deviationid
+        params['offset'] = offset if offset != 0
+        params['limit'] = limit if limit != 10
+        perform(DeviantArt::Deviation::EmbeddedContent, :get, '/api/v1/oauth2/deviation/embeddedcontent', params)
+      end
+
+      # Fetch deviation metadata for a set of deviations.
+      # This endpoint is limited to 50 deviations per query when fetching the base data and 10 when fetching extended data.
+      def get_deviation_metadata(deviationids, ext_submission: false, ext_camera: false, ext_stats: false, ext_collection: false)
+        params = { deviationids: deviationids.is_a?(Enumerable) ? deviationids : [deviationids] }
+        params['ext_submission'] = ext_submission
+        params['ext_camera'] = ext_camera
+        params['ext_stats'] = ext_stats
+        params['ext_collection'] = ext_collection
+        perform(DeviantArt::Deviation::Metadata, :get, '/api/v1/oauth2/deviation/metadata', params)
+      end
+
       # Fetch a list of users who faved the deviation
       def get_deviation_whofaved(deviationid, offset: 0, limit: 10)
         params = {}
@@ -29,8 +52,6 @@ module DeviantArt
       def download_deviation(deviationid)
         perform(DeviantArt::Deviation::Download, :get, "/api/v1/oauth2/deviation/download/#{deviationid}")
       end
-
-      # TODO: embeddedcontent, metadata
     end
   end
 end

data/lib/deviantart/client_credentials.rb

@@ -0,0 +1,6 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class ClientCredentials < Base
+  end
+end

data/lib/deviantart/client_credentials/access_token.rb

@@ -0,0 +1,8 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class ClientCredentials::AccessToken < Base
+    attr_accessor :expires_in, :status, :access_token, :token_type
+  end
+end
+

data/lib/deviantart/deviation/content.rb

@@ -2,5 +2,6 @@ require 'deviantart/base'
 
 module DeviantArt
   class Deviation::Content < Base
+    attr_accessor :html, :css, :css_fonts
   end
 end

data/lib/deviantart/deviation/download.rb

@@ -2,5 +2,6 @@ require 'deviantart/base'
 
 module DeviantArt
   class Deviation::Download < Base
+    attr_accessor :src, :width, :height, :filesize
   end
 end

data/lib/deviantart/deviation/embeddedcontent.rb

@@ -0,0 +1,8 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class Deviation::EmbeddedContent < Base
+    attr_accessor :has_more, :next_offset, :has_less, :prev_offset, :results
+    point_to_class [:results, :[]], DeviantArt::Deviation
+  end
+end

data/lib/deviantart/deviation/metadata.rb

@@ -0,0 +1,8 @@
+require 'deviantart/base'
+
+module DeviantArt
+  class Deviation::Metadata < Base
+    attr_accessor :metadata
+    point_to_class [:metadata, :[], :author], DeviantArt::User
+  end
+end

data/lib/deviantart/deviation/whofaved.rb

@@ -2,6 +2,7 @@ require 'deviantart/base'
 
 module DeviantArt
   class Deviation::WhoFaved < Base
+    attr_accessor :has_more, :next_offset, :results
     point_to_class [:results, :[], :user], DeviantArt::User
   end
 end

data/lib/deviantart/version.rb

@@ -1,3 +1,3 @@
 module DeviantArt
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deviantart
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Code Ass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,9 @@ files:
 - bin/setup
 - deviantart.gemspec
 - lib/deviantart.rb
+- lib/deviantart/authorization_code.rb
+- lib/deviantart/authorization_code/access_token.rb
+- lib/deviantart/authorization_code/refresh_token.rb
 - lib/deviantart/base.rb
 - lib/deviantart/client.rb
 - lib/deviantart/client/collections.rb
@@ -77,6 +80,8 @@ files:
 - lib/deviantart/client/feed.rb
 - lib/deviantart/client/gallery.rb
 - lib/deviantart/client/user.rb
+- lib/deviantart/client_credentials.rb
+- lib/deviantart/client_credentials/access_token.rb
 - lib/deviantart/collections.rb
 - lib/deviantart/collections/folders.rb
 - lib/deviantart/data.rb
@@ -87,6 +92,8 @@ files:
 - lib/deviantart/deviation.rb
 - lib/deviantart/deviation/content.rb
 - lib/deviantart/deviation/download.rb
+- lib/deviantart/deviation/embeddedcontent.rb
+- lib/deviantart/deviation/metadata.rb
 - lib/deviantart/deviation/whofaved.rb
 - lib/deviantart/error.rb
 - lib/deviantart/feed.rb