deviantart 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fdd663a915e28c0444e53eb3f732b93281a6524
+  data.tar.gz: a93893796b12f74c8a39c0a1c74092313c85c115
+SHA512:
+  metadata.gz: 10e554efc6cee88812149878b94cd1de27e0f26d1fd278fe9202e5f24d42d604f99525a0cc63c17249527f854a86a748e05d2dbb18af5e0de3792aa47515bdd4
+  data.tar.gz: 5f3bdb693bd1be7f1b0e0d48821067b5ee60a85ee2ae5ecfe3d77785c6fb4835f3d52a606812797820b8dcfadfd35d3c9315d23d088aa1ae91dcfaa51229a24b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+test/fixtures/authorization_code.json
+test/browser_command
+*.swp

data/.travis.yml

@@ -0,0 +1,3 @@
+---
+language: ruby
+rvm: 2.3.1

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'webmock'
+  gem 'minitest'
+  gem 'json'
+  gem 'sinatra'
+  gem 'omniauth'
+  gem 'omniauth-oauth2', '~> 1.3.1'
+  gem 'omniauth-deviantart'
+end
+
+# Specify your gem's dependencies in deviantart.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Code Ass
+
+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,91 @@
+# deviantART API library
+
+## Installation
+
+    $ gem install deviantart
+
+## Usage
+
+```ruby
+da = DeviantArt.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
+```
+
+## How to Test
+
+At the first, install gems:
+
+```bash
+$ bundle install
+```
+
+And you will run test with stub APIs:
+
+```bash
+$ bundle exec rake test
+```
+
+If you want to use *real* API in test, run this one:
+
+```bash
+$ bundle exec rake real
+Input your browser command>
+```
+
+This prompt demands browser command for OAuth 2 authorization of deviantART.
+After this, Rake task performs some steps:
+
+- creates named pipe
+- OAuth consumer server launches internal
+- opens the browser with authorization page
+
+```bash
+$ bundle exec rake real
+Input your browser command> firefox
+Wrote "firefox" to test/browser_command
+Boot Sinatra OAuth consumer...
+Open browser for authorization
+```
+
+The OAuth consumer server writes access token to named pipe and terminates after you permit it on browser.
+Rake task takes access token via named pipe.
+The tests run with the access token.
+
+```bash
+--snip--
+Open browser for authorization
+Got access token!
+# Running:
+
+..............
+
+Finished in 4.44s, 3.14159 runs/s, 11.4478 assertions/s.
+
+14 runs, 51 assertions, 0 failures, 0 errors, 0 skips
+```
+
+The browser command is cached at `test/browser_command`, the access token is cached at `test/fixtures/authorization_code.json`.
+
+## API
+
+## Official API Document
+
+[Developers - DeviantArt](https://www.deviantart.com/developers/)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Badges
+
+[![Build Status](https://travis-ci.org/aycabta/deviantart.svg)](https://travis-ci.org/aycabta/deviantart)
+

data/Rakefile

@@ -0,0 +1,83 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "readline"
+
+test_pettern = FileList['test/**/*_test.rb']
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = test_pettern
+end
+
+def get_browser_command
+  browser_command_file = 'test/browser_command'
+  if !File.exists?(browser_command_file)
+    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}"
+    browser_command
+  else
+    open(browser_command_file, 'r').read
+  end
+end
+
+def get_access_token
+  cv = ConditionVariable.new
+  mutex = Mutex.new
+  is_pinged = false
+  Thread.new {
+    mutex.synchronize {
+      puts 'Boot Sinatra OAuth consumer...'
+      system('bundle exec ruby test/oauth_consumer.rb > /dev/null 2>&1 &')
+      open(OUTPUT_PIPE).read # block to get 'ping'
+      is_pinged = true
+      cv.signal
+    }
+  }
+  is_browsed = false
+  Thread.new {
+    mutex.synchronize {
+      until is_pinged
+        cv.wait(mutex)
+      end
+      puts 'Open browser for authorization'
+      system("#{get_browser_command} http://localhost:4567/auth/deviantart &")
+      is_browsed = true
+      cv.signal
+    }
+  }
+  result = nil
+  mutex.synchronize {
+    until is_browsed
+      cv.wait(mutex)
+    end
+    result = open(OUTPUT_PIPE).read # block to get authorization code
+  }
+  puts 'Got access token!'
+  open(AUTHORIZATION_CODE_FILE, 'w') do |f|
+    f.write(result)
+  end
+end
+
+Rake::TestTask.new(:real) do |t|
+  AUTHORIZATION_CODE_FILE = 'test/fixtures/authorization_code.json'
+  if !File.exists?(AUTHORIZATION_CODE_FILE)
+    OUTPUT_PIPE = 'test/output_pipe'
+    if File.exists?(OUTPUT_PIPE)
+      File.unlink(OUTPUT_PIPE)
+    end
+    File.mkfifo(OUTPUT_PIPE)
+    get_access_token
+    File.unlink(OUTPUT_PIPE)
+  end
+  t.ruby_opts << '-I. -e "ENV[\'REAL\']=\'1\'"'
+  t.loader = :direct
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = test_pettern
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deviantart"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/deviantart.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deviantart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deviantart"
+  spec.version       = DeviantArt::VERSION
+  spec.authors       = ["Code Ass"]
+  spec.email         = ["aycabta@gmail.com"]
+
+  spec.summary       = %q{deviantART API library}
+  spec.description   = %q{deviantART API library}
+  spec.homepage      = "https://github.com/aycabta/deviantart"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.2"
+  spec.add_development_dependency "minitest", "~> 5.9"
+end

data/lib/deviantart.rb

@@ -0,0 +1,8 @@
+require "deviantart/version"
+require "deviantart/client"
+
+module DeviantArt
+  def self.new(*args, &block)
+    DeviantArt::Client.new(*args, &block)
+  end
+end

data/lib/deviantart/client.rb

@@ -0,0 +1,144 @@
+require 'deviantart/deviation'
+require 'deviantart/gallery'
+require 'deviantart/collections'
+require 'deviantart/user'
+require 'deviantart/data'
+require 'deviantart/feed'
+require 'net/http'
+require 'uri'
+require 'json'
+
+class Net::HTTPResponse
+  attr_accessor :json
+end
+
+module DeviantArt
+  class Client
+    include DeviantArt::Deviation
+    include DeviantArt::Gallery
+    include DeviantArt::Collections
+    include DeviantArt::User
+    include DeviantArt::Data
+    include DeviantArt::Feed
+    attr_accessor :access_token, :client_id, :client_secret, :code, :redirect_uri, :grant_type, :access_token_auto_refresh, :refresh_token
+    attr_writer :user_agent
+    @@host = 'www.deviantart.com'
+
+    def initialize(options = {})
+      @access_token = nil
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      yield(self) if block_given?
+      @http = Net::HTTP.new(@@host, 443)
+      @http.use_ssl = true
+      @on_refreshed_access_token = nil
+      @on_refreshed_authorization_code = nil
+    end
+
+    def self.host
+      @@host
+    end
+
+    def user_agent
+      @user_agent ||= "DeviantArtRubyGem/#{DeviantArt::VERSION}/#{RUBY_DESCRIPTION}"
+    end
+
+    def access_token_auto_refresh?
+      @access_token_auto_refresh
+    end
+
+    def perform(method, path, params = {})
+      if @access_token.nil? && access_token_auto_refresh?
+        refresh_access_token
+      end
+      response = request(method, path, params)
+      if response.code == '401' && access_token_auto_refresh?
+        refresh_access_token
+        response = request(method, path, params)
+      end
+      response.json
+    end
+
+    def on_refreshed_authorization_code(&block)
+      @on_refreshed_authorization_code = block
+    end
+
+    def on_refreshed_access_token(&block)
+      @on_refreshed_access_token = block
+    end
+
+  private
+
+    def request(method, path, params = {})
+      uri = URI.parse("https://#{@@host}#{path}")
+      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
+      end
+      request['Content-Type'] = 'application/x-www-form-urlencoded'
+      request['User-Agent'] = user_agent
+      if not @access_token.nil?
+        request["Authorization"] = "Bearer #{@access_token}"
+      end
+      response = @http.request(request)
+      response.json = JSON.parse(response.body)
+      response
+    end
+
+    def refresh_client_credentials
+      response = request(
+        :post, '/oauth2/token',
+        { grant_type: 'client_credentials', client_id: @client_id, client_secret: @client_secret }
+      )
+      if response.code == '200'
+        @access_token = response.json['access_token']
+        @on_refreshed_access_token.call(@access_token) if @on_refreshed_access_token
+      else
+        @access_token = nil
+      end
+    end
+
+    def refresh_authorization_code
+      response = request(
+        :post, '/oauth2/token',
+        { grant_type: 'refresh_token', client_id: @client_id, client_secret: @client_secret, refresh_token: @refresh_token }
+      )
+      if response.code == '200'
+        @access_token = response.json['access_token']
+        @on_refreshed_access_token.call(@access_token) if @on_refreshed_access_token
+        @on_refreshed_authorization_code.call(@access_token, response.json['refresh_token']) if @on_refreshed_authorization_code
+      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
+      end
+    end
+  end
+end
+

data/lib/deviantart/collections.rb

@@ -0,0 +1,24 @@
+module DeviantArt
+  module Collections
+    # Fetch collection folders
+    def get_collections_folders(username: nil, calculate_size: false, ext_preload: false, offset: 0, limit: 10)
+      params = {}
+      params['username'] = username unless username.nil?
+      params['calculate_size'] = calculate_size if calculate_size
+      params['ext_preload'] = ext_preload if ext_preload
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, '/api/v1/oauth2/collections/folders', params)
+    end
+
+    # Fetch collection folder contents
+    def get_collections(folderid, username: nil, offset: 0, limit: 10)
+      params = {}
+      params['username'] = username unless username.nil?
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, "/api/v1/oauth2/collections/#{folderid}", params)
+    end
+  end
+end
+

data/lib/deviantart/data.rb

@@ -0,0 +1,24 @@
+module DeviantArt
+  module Data
+    # Get a list of countries
+    def get_countries
+      perform(:get, '/api/v1/oauth2/data/countries')
+    end
+
+    # Returns the DeviantArt Privacy Policy
+    def get_privacy
+      perform(:get, '/api/v1/oauth2/data/privacy')
+    end
+
+    # Returns the DeviantArt Submission Policy
+    def get_submission
+      perform(:get, '/api/v1/oauth2/data/submission')
+    end
+
+    # Returns the DeviantArt Terms of Service
+    def get_tos
+      perform(:get, '/api/v1/oauth2/data/tos')
+    end
+  end
+end
+

data/lib/deviantart/deviation.rb

@@ -0,0 +1,28 @@
+module DeviantArt
+  module Deviation
+    # Fetch a deviation details
+    def get_deviation(deviationid)
+      perform(:get, "/api/v1/oauth2/deviation/#{deviationid}")
+    end
+
+    # Fetch full data that is not included in the main devaition details
+    def get_deviation_content(deviationid)
+      perform(:get, '/api/v1/oauth2/deviation/content', { deviationid: deviationid })
+    end
+
+    # Fetch a list of users who faved the deviation
+    def get_deviation_whofaved(deviationid, offset: 0, limit: 10)
+      params = {}
+      params['deviationid'] = deviationid
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, '/api/v1/oauth2/deviation/whofaved', params)
+    end
+
+    # Get the original file download (if allowed)
+    def download_deviation(deviationid)
+      perform(:get, "/api/v1/oauth2/deviation/download/#{deviationid}")
+    end
+  end
+end
+

data/lib/deviantart/feed.rb

@@ -0,0 +1,12 @@
+module DeviantArt
+  module Feed
+    # Fetch Watch Feed
+    def get_feed(mature_content: false, cursor: nil)
+      params = {}
+      params['cursor'] = cursor unless cursor.nil?
+      params['mature_content'] = mature_content
+      perform(:get, '/api/v1/oauth2/feed/home', params)
+    end
+  end
+end
+

data/lib/deviantart/gallery.rb

@@ -0,0 +1,39 @@
+module DeviantArt
+  module Gallery
+    # Get the "all" view of a users gallery
+    def get_gallery_all(username: nil, offset: 0, limit: 10)
+      params = {}
+      params['username'] = username unless username.nil?
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, '/api/v1/oauth2/gallery/all', params)
+    end
+
+    # Fetch gallery folders
+    def get_gallery_folders(username: nil, calculate_size: false, ext_preload: false, offset: 0, limit: 10)
+      params = {}
+      params['username'] = username unless username.nil?
+      params['calculate_size'] = calculate_size if calculate_size
+      params['ext_preload'] = ext_preload if ext_preload
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, '/api/v1/oauth2/gallery/folders', params)
+    end
+
+    # Fetch gallery folder contents
+    def get_gallery(username: nil, folderid: nil, mode: nil, offset: 0, limit: 10)
+      params = {}
+      params['username'] = username unless username.nil?
+      params['mode'] = mode unless mode.nil?
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      unless folderid.nil?
+        path = "/api/v1/oauth2/gallery/#{folderid}"
+      else
+        path = '/api/v1/oauth2/gallery/'
+      end
+      perform(:get, path, params)
+    end
+  end
+end
+

data/lib/deviantart/user.rb

@@ -0,0 +1,31 @@
+module DeviantArt
+  module User
+    # Get user profile information
+    def get_profile(username: nil, ext_collections: false, ext_galleries: false)
+      params = {}
+      params['ext_collections'] = ext_collections if ext_collections
+      params['ext_galleries'] = ext_galleries if ext_galleries
+      perform(:get, "/api/v1/oauth2/user/profile/#{username.nil? ? '' : username}", params)
+    end
+
+    # Get the users list of friends
+    def get_friends(username: nil, offset: 0, limit: 10)
+      params = {}
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, "/api/v1/oauth2/user/friends/#{username.nil? ? '' : username}", params)
+    end
+
+    # Fetch user info for given usernames
+    def whois(users)
+      params = { usernames: users.is_a?(Enumerable) ? users : [users] }
+      perform(:post, '/api/v1/oauth2/user/whois', params)
+    end
+
+    # Fetch user info of authenticated user
+    def whoami
+      perform(:get, '/api/v1/oauth2/user/whoami?')
+    end
+  end
+end
+

data/lib/deviantart/version.rb

@@ -0,0 +1,3 @@
+module DeviantArt
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: deviantart
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Code Ass
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: deviantART API library
+email:
+- aycabta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- deviantart.gemspec
+- lib/deviantart.rb
+- lib/deviantart/client.rb
+- lib/deviantart/collections.rb
+- lib/deviantart/data.rb
+- lib/deviantart/deviation.rb
+- lib/deviantart/feed.rb
+- lib/deviantart/gallery.rb
+- lib/deviantart/user.rb
+- lib/deviantart/version.rb
+homepage: https://github.com/aycabta/deviantart
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: deviantART API library
+test_files: []