deviantart 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fdd663a915e28c0444e53eb3f732b93281a6524
-  data.tar.gz: a93893796b12f74c8a39c0a1c74092313c85c115
+  metadata.gz: c8d5b6643a6f9af4d75fe988cb96492aea502fb2
+  data.tar.gz: ab439f5a0ac0c932663b906ac8a11335d57ea832
 SHA512:
-  metadata.gz: 10e554efc6cee88812149878b94cd1de27e0f26d1fd278fe9202e5f24d42d604f99525a0cc63c17249527f854a86a748e05d2dbb18af5e0de3792aa47515bdd4
-  data.tar.gz: 5f3bdb693bd1be7f1b0e0d48821067b5ee60a85ee2ae5ecfe3d77785c6fb4835f3d52a606812797820b8dcfadfd35d3c9315d23d088aa1ae91dcfaa51229a24b
+  metadata.gz: 2a28ea7daf05f8bfe250154e7c98de8d3481f08bf802bb71c020f81763c7e71f10d9dbfdf2b448a5bf0609cdf7815b16d5b0edb0e03088b553ae9b2efcfbfdd5
+  data.tar.gz: 6844ec96b4fa3c0378710077ebde6eba9167d5f6ddfa68b1eaa0ae4d5632c0f222ebaf06e74cf26abae88c6907b08ccd630d88b0456789eb64b507e8dc50fd7b

data/.travis.yml

@@ -1,3 +1,4 @@
 ---
 language: ruby
 rvm: 2.3.1
+script: REAL='' bundle exec rake test

data/Rakefile

@@ -62,7 +62,7 @@ def get_access_token
   end
 end
 
-Rake::TestTask.new(:real) do |t|
+task :access_token do
   AUTHORIZATION_CODE_FILE = 'test/fixtures/authorization_code.json'
   if !File.exists?(AUTHORIZATION_CODE_FILE)
     OUTPUT_PIPE = 'test/output_pipe'
@@ -73,6 +73,10 @@ Rake::TestTask.new(:real) do |t|
     get_access_token
     File.unlink(OUTPUT_PIPE)
   end
+end
+
+Rake::TestTask.new(:real) do |t|
+  t.deps << :access_token
   t.ruby_opts << '-I. -e "ENV[\'REAL\']=\'1\'"'
   t.loader = :direct
   t.libs << "test"

data/lib/deviantart.rb

@@ -2,6 +2,7 @@ require "deviantart/version"
 require "deviantart/client"
 
 module DeviantArt
+  # Bypass args and block to DeviantArt::Client
   def self.new(*args, &block)
     DeviantArt::Client.new(*args, &block)
   end

data/lib/deviantart/client.rb

@@ -4,6 +4,7 @@ require 'deviantart/collections'
 require 'deviantart/user'
 require 'deviantart/data'
 require 'deviantart/feed'
+# TODO: comments, cured, messages, notes, stash, util
 require 'net/http'
 require 'uri'
 require 'json'
@@ -20,34 +21,61 @@ module DeviantArt
     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_accessor :access_token, :client_id, :client_secret, :code, :redirect_uri, :grant_type, :access_token_auto_refresh, :refresh_token, :host
     attr_writer :user_agent
-    @@host = 'www.deviantart.com'
+    @@default_host = 'www.deviantart.com'
 
+    # Create client object.
+    #
+    # [#host] Host name to access API.
+    # [#access_token_auto_refresh] Bool for auto refresh access token.
+    # [#grant_type]
+    #   Use for refresh token.
+    #   - +:authorization_code+
+    #   - +:client_credentials+
+    # [#access_token] This is valid access token for now.
+    #
+    # For refresh token with +:authorization_code+
+    #
+    # [#client_id] App's +client_id+.
+    # [#client_secret] App's +client_secret+.
+    # [#redirect_uri] URL what is exactly match the value in authorization step.
+    # [#code] Authorization step returns this.
+    # [#refresh_token] Refresh token for +:authorization_code+.
+    #
+    # For refresh token with +:client_credentials+
+    #
+    # [#client_id] App's +client_id+.
+    # [#client_secret] App's +client_secret+.
     def initialize(options = {})
       @access_token = nil
+      @host = @@default_host
+      @on_refresh_access_token = nil
+      @on_refresh_authorization_code = nil
       options.each do |key, value|
         instance_variable_set("@#{key}", value)
       end
       yield(self) if block_given?
-      @http = Net::HTTP.new(@@host, 443)
+      @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
+    # Default host name, it's 'www.deviantart.com'
+    def self.default_host
+      @@default_host
     end
 
+    # User agent name
     def user_agent
       @user_agent ||= "DeviantArtRubyGem/#{DeviantArt::VERSION}/#{RUBY_DESCRIPTION}"
     end
 
+    # Auto refresh access token flag
     def access_token_auto_refresh?
       @access_token_auto_refresh
     end
 
+    # Access API with params by method
     def perform(method, path, params = {})
       if @access_token.nil? && access_token_auto_refresh?
         refresh_access_token
@@ -60,18 +88,20 @@ module DeviantArt
       response.json
     end
 
-    def on_refreshed_authorization_code(&block)
-      @on_refreshed_authorization_code = block
+    # Call given block when authorization code is refreshed
+    def on_refresh_authorization_code(&block)
+      @on_refresh_authorization_code = block
     end
 
-    def on_refreshed_access_token(&block)
-      @on_refreshed_access_token = block
+    # Call given block when access token is refreshed
+    def on_refresh_access_token(&block)
+      @on_refresh_access_token = block
     end
 
   private
 
     def request(method, path, params = {})
-      uri = URI.parse("https://#{@@host}#{path}")
+      uri = URI.parse("https://#{@host}#{path}")
       case method
       when :get
         uri.query = URI.encode_www_form(params)
@@ -111,7 +141,7 @@ module DeviantArt
       )
       if response.code == '200'
         @access_token = response.json['access_token']
-        @on_refreshed_access_token.call(@access_token) if @on_refreshed_access_token
+        @on_refresh_access_token.call(@access_token) if @on_refresh_access_token
       else
         @access_token = nil
       end
@@ -124,8 +154,8 @@ module DeviantArt
       )
       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
+        @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
       else
         @access_token = nil
       end

data/lib/deviantart/collections.rb

@@ -19,6 +19,8 @@ module DeviantArt
       params['limit'] = limit if limit != 10
       perform(:get, "/api/v1/oauth2/collections/#{folderid}", params)
     end
+
+    # TODO: fave, folders/create, folders/remove/{folderid}, unfav
   end
 end
 

data/lib/deviantart/deviation.rb

@@ -23,6 +23,8 @@ module DeviantArt
     def download_deviation(deviationid)
       perform(:get, "/api/v1/oauth2/deviation/download/#{deviationid}")
     end
+
+    # TODO: embeddedcontent, metadata
   end
 end
 

data/lib/deviantart/feed.rb

@@ -7,6 +7,8 @@ module DeviantArt
       params['mature_content'] = mature_content
       perform(:get, '/api/v1/oauth2/feed/home', params)
     end
+
+    # TODO: home/{bucketid}, notifications, profile, settings, settings/update
   end
 end
 

data/lib/deviantart/gallery.rb

@@ -34,6 +34,8 @@ module DeviantArt
       end
       perform(:get, path, params)
     end
+
+    # TODO: create, remove/{folderid}
   end
 end
 

data/lib/deviantart/user.rb

@@ -1,7 +1,7 @@
 module DeviantArt
   module User
     # Get user profile information
-    def get_profile(username: nil, ext_collections: false, ext_galleries: false)
+    def get_profile(username, ext_collections: false, ext_galleries: false)
       params = {}
       params['ext_collections'] = ext_collections if ext_collections
       params['ext_galleries'] = ext_galleries if ext_galleries
@@ -9,7 +9,7 @@ module DeviantArt
     end
 
     # Get the users list of friends
-    def get_friends(username: nil, offset: 0, limit: 10)
+    def get_friends(username, offset: 0, limit: 10)
       params = {}
       params['offset'] = offset if offset != 0
       params['limit'] = limit if limit != 10
@@ -26,6 +26,25 @@ module DeviantArt
     def whoami
       perform(:get, '/api/v1/oauth2/user/whoami?')
     end
+
+    # Search friends by username
+    def search_friends(query, username: nil)
+      params = {}
+      params['query'] = query
+      params['username'] = username unless username.nil?
+      perform(:get, '/api/v1/oauth2/user/friends/search', params)
+    end
+
+    def get_statuses(username, offset: 0, limit: 10, mature_content: false)
+      params = {}
+      params['username'] = username
+      params['mature_content'] = mature_content
+      params['offset'] = offset if offset != 0
+      params['limit'] = limit if limit != 10
+      perform(:get, '/api/v1/oauth2/user/statuses/', params)
+    end
+
+    # TODO: damntoken, friends/unwatch/{username}, friends/watch/{username}, friends/watching/{username}, profile/update, ertatuses/{statusid}, statuses/post, watchers/{username}
   end
 end
 

data/lib/deviantart/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deviantart
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Code Ass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler