qiita 0.0.3 → 1.0.0

data/lib/qiita/client.rb

@@ -1,88 +1,152 @@
-require 'faraday'
-require 'faraday_middleware'
-require 'faraday/response/raise_qiita_error.rb'
-require 'json'
-require 'qiita'
-require 'qiita/error'
-require 'qiita/client/items'
-require 'qiita/client/tags'
-require 'qiita/client/users'
+require "qiita/resource_based_methods"
+require "qiita/version"
 
+## Qiita::Client
+# A class for API client to send HTTP request.
+#
 module Qiita
   class Client
-    ROOT_URL = 'https://qiita.com/'
-    OPTIONS_KEYS = [:url_name, :password, :token].freeze
+    DEFAULT_ACCEPT = "application/json"
 
-    attr_accessor *OPTIONS_KEYS
+    DEFAULT_HOST = "qiita.com"
 
-    def initialize(args)
-      OPTIONS_KEYS.each do |key|
-        send("#{key}=", args[key])
-      end
-      if token.nil? && url_name && password
-        login
-      end
+    DEFAULT_USER_AGENT = "Qiita Ruby Gem #{Qiita::VERSION}"
+
+    DEFAULT_HEADERS = {
+      "Accept" => DEFAULT_ACCEPT,
+      "User-Agent" => DEFAULT_USER_AGENT,
+    }
+
+    include ResourceBasedMethods
+
+    # ### Qiita::Client.new(options = {})
+    # Creates a new instance of `Qiita::Client` class.
+    # `options` can have following key-values:
+    #
+    # * `access_token` - (String) Access token issued to authenticate and authorize user.
+    # * `host` - (String) Hostname where this client accesses to.
+    # * `team` - (String) Team name to be used as subdomain.
+    #
+    # ```rb
+    # Qiita::Client.new
+    # Qiita::Client.new(access_token: "...")
+    # Qiita::Client.new(host: "my-team-name.qiita.com")
+    # Qiita::Client.new(team: "my-team-name")
+    # ```
+    #
+    def initialize(access_token: nil, host: nil, team: nil)
+      @access_token = access_token
+      @host = host
+      @team = team
     end
 
-    def rate_limit params={}
-      get '/rate_limit', params
+    # ### Qiita::Client#get(path, params = nil, headers = nil)
+    # Sends GET request with given parameters, then returns a `Qiita::Response`.
+    # `params` are url-encoded and used as URI query string.
+    #
+    # ```rb
+    # client.get("/api/v2/items", page: 2)
+    # ```
+    #
+    def get(path, params = nil, headers = nil)
+      process(:get, path, params, headers)
     end
 
-    include Qiita::Client::Items
-    include Qiita::Client::Tags
-    include Qiita::Client::Users
+    # ### Qiita::Client#post(path, params = nil, headers = nil)
+    # Sends POST request with given parameters, then returns a Qiita::Response.
+    # `params` are JSON-encoded and used as request body.
+    #
+    # ```rb
+    # client.post("/api/v2/items", title: "...", body: "...")
+    # ```
+    #
+    def post(path, params = nil, headers = nil)
+      process(:post, path, params, headers)
+    end
 
-    private
+    # ### Qiita::Client#patch(path, params = nil, headers = nil)
+    # Sends PATCH request with given parameters, then returns a Qiita::Response.
+    # `params` are JSON-encoded and used as request body.
+    #
+    # ```rb
+    # client.patch("/api/v2/items/543efd13001e30837319", title: "...", body: "...")
+    # ```
+    #
+    def patch(path, params = nil, headers = nil)
+      process(:patch, path, params, headers)
+    end
+
+    # ### Qiita::Client#put(path, params = nil, headers = nil)
+    # Sends PUT request, then returns a Qiita::Response.
+    # `params` are JSON-encoded and used as request body.
+    #
+    # ```rb
+    # client.put("/api/v2/items/543efd13001e30837319/stock")
+    # ```
+    #
+    def put(path, params = nil, headers = nil)
+      process(:put, path, params, headers)
+    end
 
-    def login
-      json = post '/auth', { :url_name => @url_name, :password => @password }
-      @token = json['token']
+    # ### Qiita::Client#delete(path, params = nil, headers = nil)
+    # Sends DELETE request, then returns a Qiita::Response.
+    # `params` are url-encoded and used as URI query string.
+    #
+    # ```rb
+    # client.delete("/api/v2/items/543efd13001e30837319/stock")
+    # ```
+    #
+    def delete(path, params = nil, headers = nil)
+      process(:delete, path, params, headers)
     end
 
+    # ### Qiita::Client#connection
+    # Returns a Faraday::Connection to customize by your favorite middlewares.
+    #
+    # ```rb
+    # client.connection.response :logger
+    # ```
+    #
     def connection
-      options = {
-        :url => ROOT_URL,
-        :ssl => { :verify => false }
-      }
-      @connection ||= Faraday.new(options) do |faraday|
-        faraday.request :json
-        faraday.adapter Faraday.default_adapter
-        faraday.use Faraday::Response::RaiseQiitaError
-        faraday.use FaradayMiddleware::Mashify
-        faraday.use FaradayMiddleware::ParseJson
+      @connection ||= Faraday.new(headers: default_headers, url: url_prefix) do |connection|
+        connection.request :json
+        connection.response :json
+        connection.adapter Faraday.default_adapter
       end
     end
 
-    def get(path, params={})
-      request(:get, path, params)
-    end
+    private
 
-    def delete(path, params={})
-      request(:delete, path, params)
+    def default_headers
+      headers = DEFAULT_HEADERS.clone
+      headers["Authorization"] = "Bearer #{@access_token}" if @access_token
+      headers
     end
 
-    def post(path, params={})
-      request(:post, path, params)
+    def host
+      case
+      when @host
+        @host
+      when @team
+        "#{@team}.#{DEFAULT_HOST}"
+      else
+        DEFAULT_HOST
+      end
     end
 
-    def put(path, params={})
-      request(:put, path, params)
+    def process(request_method, path, params, headers)
+      Qiita::Response.new(
+        connection.send(
+          request_method,
+          path,
+          params,
+          headers,
+        )
+      )
     end
 
-    def request(method, path, params)
-      path = "/api/v1/#{path}"
-      params.merge!(:token => token) if token
-      response = connection.send(method) do |req|
-        req.headers['Content-Type'] = 'application/json'
-        case method
-        when :get, :delete
-          req.url path, params
-        when :post, :put
-          req.path = path
-          req.body = params.to_json unless params.empty?
-        end
-      end
-      response.body
+    def url_prefix
+      "https://#{host}"
     end
   end
 end

data/lib/qiita/command_builder.rb

@@ -0,0 +1,35 @@
+# ## Qiita::CommandBuilder
+# Creates a new command object from given ARGV.
+#
+# ```ruby
+# builder = Qiita::CommandBuilder.new(ARGV)
+# builder.call
+# ```
+#
+module Qiita
+  class CommandBuilder
+    ### Qiita::CommandBuilder.new(argv)
+    # Creates a new instance of Qiita::CommandBuilder from given command line arguments.
+    #
+    def initialize(argv)
+      @argv = argv
+    end
+
+    ### Qiita::CommandBuilder#call
+    # Returns a new instance of command class that inherited from Qiita::Commands::Base.
+    #
+    def call
+      if arguments.valid?
+        Qiita::Commands::Request.new(arguments)
+      else
+        Qiita::Commands::Error.new(arguments)
+      end
+    end
+
+    private
+
+    def arguments
+      @arguments ||= Arguments.new(@argv)
+    end
+  end
+end

data/lib/qiita/commands/base.rb

@@ -0,0 +1,13 @@
+module Qiita
+  module Commands
+    class Base
+      def initialize(arguments)
+        @arguments = arguments
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/qiita/commands/error.rb

@@ -0,0 +1,9 @@
+module Qiita
+  module Commands
+    class Error < Base
+      def call
+        abort(@arguments.error_message)
+      end
+    end
+  end
+end

data/lib/qiita/commands/request.rb

@@ -0,0 +1,30 @@
+module Qiita
+  module Commands
+    class Request < Base
+      def call
+        response = client.send(
+          @arguments.method_name,
+          *@arguments.arguments,
+          @arguments.params,
+          @arguments.headers,
+        )
+        print ResponseRenderer.new(
+          response,
+          color: @arguments.color,
+          show_body: @arguments.show_body,
+          show_header: @arguments.show_header,
+        )
+      end
+
+      private
+
+      def client
+        Client.new(
+          access_token: @arguments.access_token,
+          host: @arguments.host,
+          team: @arguments.team,
+        )
+      end
+    end
+  end
+end

data/lib/qiita/resource_based_methods.rb

@@ -0,0 +1,283 @@
+module Qiita
+  module ResourceBasedMethods
+    # ### Qiita::Client#create_access_token(params = nil, headers = nil)
+    # 与えられた認証情報をもとに新しいアクセストークンを発行します。
+    #
+    def create_access_token(params = nil, headers = nil)
+      post("/api/v2/access_tokens", params, headers)
+    end
+
+    # ### Qiita::Client#delete_access_token(token, params = nil, headers = nil)
+    # 与えられたアクセストークンを失効させ、それ以降利用されないようにします。
+    #
+    def delete_access_token(token, params = nil, headers = nil)
+      delete("/api/v2/access_tokens/#{token}", params, headers)
+    end
+
+    # ### Qiita::Client#get_comment(id, params = nil, headers = nil)
+    # 特定のコメントを返します。
+    #
+    def get_comment(id, params = nil, headers = nil)
+      get("/api/v2/comments/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#delete_comment(id, params = nil, headers = nil)
+    # 特定のコメントを削除します。
+    #
+    def delete_comment(id, params = nil, headers = nil)
+      delete("/api/v2/comments/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#update_comment(id, params = nil, headers = nil)
+    # 特定のコメントを更新します。
+    #
+    def update_comment(id, params = nil, headers = nil)
+      patch("/api/v2/comments/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#list_item_comments(item_id, params = nil, headers = nil)
+    # 特定の投稿に寄せられたコメント一覧を返します。
+    #
+    def list_item_comments(item_id, params = nil, headers = nil)
+      get("/api/v2/items/#{item_id}/comments", params, headers)
+    end
+
+    # ### Qiita::Client#create_item_comment(item_id, params = nil, headers = nil)
+    # 特定の投稿にコメントを付けます。
+    #
+    def create_item_comment(item_id, params = nil, headers = nil)
+      post("/api/v2/items/#{item_id}/comments", params, headers)
+    end
+
+    # ### Qiita::Client#thank_comment(comment_id, params = nil, headers = nil)
+    # 特定のコメントにThankを付けます。
+    #
+    def thank_comment(comment_id, params = nil, headers = nil)
+      put("/api/v2/comments/#{comment_id}/thank", params, headers)
+    end
+
+    # ### Qiita::Client#unthank_comment(comment_id, params = nil, headers = nil)
+    # 特定のコメントからThankを外します。
+    #
+    def unthank_comment(comment_id, params = nil, headers = nil)
+      delete("/api/v2/comments/#{comment_id}/thank", params, headers)
+    end
+
+    # ### Qiita::Client#list_items(params = nil, headers = nil)
+    # 新着順に全ての投稿一覧を返します。
+    #
+    def list_items(params = nil, headers = nil)
+      get("/api/v2/items", params, headers)
+    end
+
+    # ### Qiita::Client#create_item(params = nil, headers = nil)
+    # 新たに投稿を作成します。
+    #
+    def create_item(params = nil, headers = nil)
+      post("/api/v2/items", params, headers)
+    end
+
+    # ### Qiita::Client#get_item(id, params = nil, headers = nil)
+    # 特定の投稿を返します。
+    #
+    def get_item(id, params = nil, headers = nil)
+      get("/api/v2/items/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#update_item(id, params = nil, headers = nil)
+    # 特定の投稿を編集します。
+    #
+    def update_item(id, params = nil, headers = nil)
+      patch("/api/v2/items/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#delete_item(id, params = nil, headers = nil)
+    # 特定の投稿を削除します。
+    #
+    def delete_item(id, params = nil, headers = nil)
+      delete("/api/v2/items/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#list_tag_items(id, params = nil, headers = nil)
+    # 特定のタグが付けられた投稿一覧を返します。
+    #
+    def list_tag_items(id, params = nil, headers = nil)
+      get("/api/v2/tags/#{id}/items", params, headers)
+    end
+
+    # ### Qiita::Client#list_user_items(user_id, params = nil, headers = nil)
+    # 特定のユーザの投稿一覧を返します。
+    #
+    def list_user_items(user_id, params = nil, headers = nil)
+      get("/api/v2/users/#{user_id}/items", params, headers)
+    end
+
+    # ### Qiita::Client#list_user_stocks(user_id, params = nil, headers = nil)
+    # 特定のユーザがストックした投稿一覧を返します。
+    #
+    def list_user_stocks(user_id, params = nil, headers = nil)
+      get("/api/v2/users/#{user_id}/stocks", params, headers)
+    end
+
+    # ### Qiita::Client#stock_item(item_id, params = nil, headers = nil)
+    # 特定の投稿をストックします。
+    #
+    def stock_item(item_id, params = nil, headers = nil)
+      put("/api/v2/items/#{item_id}/stock", params, headers)
+    end
+
+    # ### Qiita::Client#unstock_item(item_id, params = nil, headers = nil)
+    # 特定の投稿をストックから取り除きます。
+    #
+    def unstock_item(item_id, params = nil, headers = nil)
+      delete("/api/v2/items/#{item_id}/stock", params, headers)
+    end
+
+    # ### Qiita::Client#lgtm_item(item_id, params = nil, headers = nil)
+    # 特定の投稿に「いいね！」を付けます。
+    #
+    def lgtm_item(item_id, params = nil, headers = nil)
+      put("/api/v2/items/#{item_id}/lgtm", params, headers)
+    end
+
+    # ### Qiita::Client#unlgtm_item(item_id, params = nil, headers = nil)
+    # 特定の投稿への「いいね！」を取り消します。
+    #
+    def unlgtm_item(item_id, params = nil, headers = nil)
+      delete("/api/v2/items/#{item_id}/lgtm", params, headers)
+    end
+
+    # ### Qiita::Client#list_projects(params = nil, headers = nil)
+    # チーム内に存在するプロジェクト一覧を返します。
+    #
+    def list_projects(params = nil, headers = nil)
+      get("/api/v2/projects", params, headers)
+    end
+
+    # ### Qiita::Client#get_project(id, params = nil, headers = nil)
+    # 特定のプロジェクトを返します。
+    #
+    def get_project(id, params = nil, headers = nil)
+      get("/api/v2/projects/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#create_project(params = nil, headers = nil)
+    # プロジェクトを新たに作成します。
+    #
+    def create_project(params = nil, headers = nil)
+      post("/api/v2/projects", params, headers)
+    end
+
+    # ### Qiita::Client#delete_project(id, params = nil, headers = nil)
+    # 特定のプロジェクトを削除します。
+    #
+    def delete_project(id, params = nil, headers = nil)
+      delete("/api/v2/projects/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#update_project(id, params = nil, headers = nil)
+    # 特定のプロジェクトを編集します。
+    #
+    def update_project(id, params = nil, headers = nil)
+      patch("/api/v2/projects/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#create_expanded_template(params = nil, headers = nil)
+    # 受け取ったテンプレート用文字列の変数を展開して返します。
+    #
+    def create_expanded_template(params = nil, headers = nil)
+      post("/api/v2/expanded_templates", params, headers)
+    end
+
+    # ### Qiita::Client#list_tags(params = nil, headers = nil)
+    # 全てのタグ一覧を返します。
+    #
+    def list_tags(params = nil, headers = nil)
+      get("/api/v2/tags", params, headers)
+    end
+
+    # ### Qiita::Client#get_tag(id, params = nil, headers = nil)
+    # 特定のタグを返します。
+    #
+    def get_tag(id, params = nil, headers = nil)
+      get("/api/v2/tags/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#list_user_following_tags(user_id, params = nil, headers = nil)
+    # 特定のユーザがフォローしているタグ一覧を返します。
+    #
+    def list_user_following_tags(user_id, params = nil, headers = nil)
+      get("/api/v2/users/#{user_id}/following_tags", params, headers)
+    end
+
+    # ### Qiita::Client#list_templates(params = nil, headers = nil)
+    # 全てのテンプレート一覧を返します。
+    #
+    def list_templates(params = nil, headers = nil)
+      get("/api/v2/templates", params, headers)
+    end
+
+    # ### Qiita::Client#get_template(id, params = nil, headers = nil)
+    # 特定のテンプレートを返します。
+    #
+    def get_template(id, params = nil, headers = nil)
+      get("/api/v2/templates/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#delete_template(id, params = nil, headers = nil)
+    # 特定のテンプレートを削除します。
+    #
+    def delete_template(id, params = nil, headers = nil)
+      delete("/api/v2/templates/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#create_template(params = nil, headers = nil)
+    # 新しくテンプレートを作成します。
+    #
+    def create_template(params = nil, headers = nil)
+      post("/api/v2/templates", params, headers)
+    end
+
+    # ### Qiita::Client#update_template(id, params = nil, headers = nil)
+    # 特定のテンプレートを編集します。
+    #
+    def update_template(id, params = nil, headers = nil)
+      patch("/api/v2/templates/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#list_users(params = nil, headers = nil)
+    # 全てのユーザの一覧を返します。
+    #
+    def list_users(params = nil, headers = nil)
+      get("/api/v2/users", params, headers)
+    end
+
+    # ### Qiita::Client#get_user(id, params = nil, headers = nil)
+    # 特定のユーザを返します。
+    #
+    def get_user(id, params = nil, headers = nil)
+      get("/api/v2/users/#{id}", params, headers)
+    end
+
+    # ### Qiita::Client#get_authenticated_user(params = nil, headers = nil)
+    # アクセストークンに紐付いたユーザを返します。
+    #
+    def get_authenticated_user(params = nil, headers = nil)
+      get("/api/v2/authenticated_user", params, headers)
+    end
+
+    # ### Qiita::Client#list_user_followees(user_id, params = nil, headers = nil)
+    # 特定のユーザがフォローしているユーザ一覧を返します。
+    #
+    def list_user_followees(user_id, params = nil, headers = nil)
+      get("/api/v2/users/#{user_id}/followees", params, headers)
+    end
+
+    # ### Qiita::Client#list_user_followers(user_id, params = nil, headers = nil)
+    # 特定のユーザをフォローしているユーザ一覧を返します。
+    #
+    def list_user_followers(user_id, params = nil, headers = nil)
+      get("/api/v2/users/#{user_id}/followers", params, headers)
+    end
+  end
+end