pixiv_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 961ad581d6a5b885d569658d903f45de1e6ef087
+  data.tar.gz: a56caea6f1ab24fcdda97b62e20f98aedbc8835b
+SHA512:
+  metadata.gz: 9bb6d66208eeed8bdd055a34f14a1246790e88f32fa10f8018c648626990dc99c1306fb69b9260e2d529581e1c7d0e107941a19c306d2d8bfee44ec7d2700ece
+  data.tar.gz: 6647a7baca1df1e35315598b2f05dd52b26dba0845e359f3dd343d2f61c808450e52bad47ac59b8c702bb425b04a9c014df5bcae295f4fb15d41ede80bdb36a7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'oauth2'
+gem 'memoizable'
+gem 'activesupport'
+gem 'mime-types'
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 alpaca-tc
+
+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,33 @@
+# PixivApi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pixiv_api', github: 'pixiv/pixiv-api-ruby'
+```
+
+## Usage
+
+```
+# Setup
+PixivApi.configure do |config|
+  config[:client_id] = '...'
+  config[:client_secret] = '...'
+  config[:site] = '...' 
+  config[:authorize_url] = '...' 
+  config[:token_url] = '...'
+end
+
+user = User.first # Sign in with Oauth2
+
+client = PixivApi::Client.new(
+  access_token: user.access_token,
+  refresh_token: user.refresh_token,
+  expires_at: user.expires_at
+)
+
+client.me # => return '/v1/me.json'
+client.work(id: 1) # => '/v1/works/:id.json'
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pixiv_api.rb

@@ -0,0 +1,22 @@
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/hash/deep_merge'
+
+module PixivApi
+  autoload :VERSION, 'pixiv_api/version'
+  autoload :Client, 'pixiv_api/client'
+  autoload :Authentication, 'pixiv_api/authentication'
+  autoload :ArrayResponse, 'pixiv_api/array_response'
+  autoload :Configuration, 'pixiv_api/configuration'
+  autoload :Identity, 'pixiv_api/identity'
+  autoload :Request, 'pixiv_api/request'
+  autoload :Response, 'pixiv_api/response'
+  autoload :PixivBlob, 'pixiv_api/pixiv_blob'
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/pixiv_api/array_response.rb

@@ -0,0 +1,23 @@
+require 'memoizable'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module PixivApi
+  class ArrayResponse < Array
+    def self.from_response(response, klass, array)
+      new(response).tap do |array_response|
+        array.each do |attributes|
+          array_response << klass.from_response(response, attributes)
+        end
+      end
+    end
+
+    def initialize(response)
+      super()
+      @response = response
+    end
+
+    def pagination
+      @pagination ||= Response::Pagination.new(@response, @response.parsed['pagination'])
+    end
+  end
+end

data/lib/pixiv_api/authentication.rb

@@ -0,0 +1,60 @@
+require 'faraday'
+require 'json'
+
+module PixivApi
+  class Authentication
+    # Authentication provides password authentication for development.
+    class InvalidAuthError < StandardError; end
+
+    def initialize(id:, password:)
+      connection = Faraday.new(default_options) do |conn|
+        # Set default middleware
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter Faraday.default_adapter
+      end
+
+      @response = connection.post(
+        URI(configuration[:token_url]).path,
+        client_id: configuration[:client_id],
+        client_secret: configuration[:client_secret],
+        grant_type: 'password',
+        username: id,
+        password: password
+      )
+
+      raise InvalidAuthError, body['errors'].to_s unless success?
+    end
+
+    def body
+      @body ||= JSON.parse(@response.body).freeze
+    end
+
+    def to_client
+      PixivApi::Client.new(
+        access_token: body['access_token'],
+        refresh_token: body['refresh_token'],
+        expires_at: Time.now.to_i + body['expires_in']
+      )
+    end
+
+    def success?
+      @response.success?
+    end
+
+    private
+
+    def configuration
+      PixivApi.configuration.tap(&:require_keys!)
+    end
+
+    def default_options
+      {
+        headers: {
+          'Host' => URI(configuration[:token_url]).host,
+        },
+        url: configuration[:site],
+      }
+    end
+  end
+end

data/lib/pixiv_api/client.rb

@@ -0,0 +1,72 @@
+require 'forwardable'
+require 'oauth2'
+
+module PixivApi
+  class Client
+    class UnsupportedApiError < NotImplementedError; end
+
+    extend Forwardable
+
+    include Request::FavoriteUsers
+    include Request::Friends
+    include Request::Novels
+    include Request::Profiles
+    include Request::Promotions
+    include Request::Ranking
+    include Request::Search
+    include Request::Trends
+    include Request::Users
+    include Request::Util
+    include Request::Version
+    include Request::Works
+    include Request::UploadWork
+    include Request::Signup
+
+    attr_reader :client, :access_token
+
+    def_delegators :@access_token, :get, :post, :put, :patch, :delete
+
+    # For development
+    def self.from_account(id:, password:)
+      PixivApi::Authentication.new(id: id, password: password).to_client
+    end
+
+    def initialize(access_token:, refresh_token:, expires_at:)
+      token_hash = {
+        access_token: access_token,
+        refresh_token: refresh_token,
+        expires_at: expires_at.to_i
+      }
+
+      @client = OAuth2::Client.new(*client_configuration) do |builder|
+        builder.request :multipart
+        builder.request :url_encoded
+        builder.adapter Faraday.default_adapter
+      end
+      @access_token = OAuth2::AccessToken.from_hash(client, token_hash)
+    end
+
+    def refresh!
+      @access_token = @access_token.refresh!
+    end
+
+    private
+
+    def unsupported!(path)
+      raise PixivApi::Client::UnsupportedApiError, "route of #{path} is not supported."
+    end
+
+    def client_configuration
+      configuration = PixivApi.configuration
+      configuration.require_keys! # 必要な設定がなされているかチェック
+
+      [
+        configuration.client_id,
+        configuration.client_secret,
+        site: configuration.site,
+        authorize_url: configuration.authorize_url,
+        token_url: configuration.token_url
+      ]
+    end
+  end
+end

data/lib/pixiv_api/configuration.rb

@@ -0,0 +1,48 @@
+require 'tmpdir'
+
+module PixivApi
+  class Configuration < Hash
+    class MissingConfigurationError < StandardError; end
+    class InvalidKeyError < StandardError; end
+
+    REQUIRED_KEYS = %i(
+      client_id client_secret site authorize_url token_url
+    )
+
+    OPTIONAL_KEYS = %i(
+      cache_dir
+    )
+
+    (REQUIRED_KEYS + OPTIONAL_KEYS).each do |key|
+      define_method key do
+        self[key]
+      end
+    end
+
+    def cache_dir
+      self[:cache_dir] || Dir.mktmpdir('pixiv-api')
+    end
+
+    def []=(key, value)
+      if allowed_keys.include?(key)
+        super
+      else
+        raise InvalidKeyError, "#{key} is not configuration key."
+      end
+    end
+
+    def require_keys!
+      REQUIRED_KEYS.each do |key|
+        raise MissingConfigurationError, "configuration requires '#{key}'" unless self[key]
+      end
+
+      self
+    end
+
+    private
+
+    def allowed_keys
+      REQUIRED_KEYS + OPTIONAL_KEYS
+    end
+  end
+end

data/lib/pixiv_api/pixiv_blob.rb

@@ -0,0 +1,41 @@
+require 'open-uri'
+require 'securerandom'
+
+module PixivApi
+  class PixivBlob
+    REFERER = 'https://www.pixiv.net/'
+
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def read
+      open(&:read)
+    end
+
+    def open(&block)
+      File.open(filepath, &block)
+    end
+
+    def to_path
+      filepath
+    end
+
+    private
+
+    def filepath
+      File.join(PixivApi.configuration.cache_dir, filename).tap do |filepath|
+        OpenURI.open_uri(url, 'Referer' => REFERER) do |uri|
+          File.open(filepath, 'wb') { |f| f.write(uri.read) }
+        end
+      end
+    end
+
+    def filename
+      extname = File.extname(@url).downcase
+      "#{SecureRandom.uuid}#{extname}"
+    end
+  end
+end

data/lib/pixiv_api/request.rb

@@ -0,0 +1,18 @@
+module PixivApi
+  module Request
+    require 'pixiv_api/request/favorite_users'
+    require 'pixiv_api/request/friends'
+    require 'pixiv_api/request/novels'
+    require 'pixiv_api/request/profiles'
+    require 'pixiv_api/request/promotions'
+    require 'pixiv_api/request/ranking'
+    require 'pixiv_api/request/search'
+    require 'pixiv_api/request/signup'
+    require 'pixiv_api/request/trends'
+    require 'pixiv_api/request/upload_work'
+    require 'pixiv_api/request/users'
+    require 'pixiv_api/request/util'
+    require 'pixiv_api/request/version'
+    require 'pixiv_api/request/works'
+  end
+end

data/lib/pixiv_api/request/favorite_users.rb

@@ -0,0 +1,19 @@
+module PixivApi
+  module Request
+    module FavoriteUsers
+      def favorite_users(*args)
+        objects_from_response(Response::User, :get, '/v1/me/favorite-users.json', args.extract_options!)
+      end
+
+      def delete_favorite_users(user_ids: [], **args)
+        options = args.deep_merge(params: { delete_ids: user_ids.join(',') })
+        action_from_response(:delete, '/v1/me/favorite-users.json', options)
+      end
+
+      def favorite_user(user_id:, publicity:, **args)
+        options = args.deep_merge(params: { target_user_id: user_id, publicity: publicity })
+        action_from_response(:post, '/v1/me/favorite-users.json', options)
+      end
+    end
+  end
+end

data/lib/pixiv_api/request/friends.rb

@@ -0,0 +1,9 @@
+module PixivApi
+  module Request
+    module Friends
+      def friends(*args)
+        objects_from_response(Response::Friend, :get, '/v1/me/friends.json', *args)
+      end
+    end
+  end
+end

data/lib/pixiv_api/request/novels.rb

@@ -0,0 +1,21 @@
+module PixivApi
+  module Request
+    module Novels
+      def my_novels(*args)
+        unsupported!('/v1/me/novels.json')
+      end
+
+      def novels(*args)
+        unsupported!('/v1/novels.json')
+      end
+
+      def user_novels(user_id:, **args)
+        unsupported!('/v1/users/:user_id/novels.json')
+      end
+
+      def novel(id:, **args)
+        unsupported!('/v1/novels/:id.json')
+      end
+    end
+  end
+end