kiita 0.1.0

data/lib/kiita/post.rb

@@ -0,0 +1,41 @@
+module Kiita
+  class Post
+    include Kiita::Model
+    attr_reader :uuid
+
+    cattr_reader :attributes
+    @@attributes = %w[
+      id title body created_at updated_at created_at_in_words updated_at_in_words
+      stock_count stock_users comment_count url gist_url private stocked
+    ]
+
+    define_attributes @@attributes, Proc.new{ Kiita::API.get("/items/#{uuid}") }
+
+    def initialize(uuid, options = {})
+      if uuid.is_a?(Hash)
+        options = uuid
+        @uuid = options["uuid"]
+      else
+        @uuid = uuid
+      end
+
+      super(options)
+    end
+
+    def self.all(options = {})
+      Kiita::API.get("/items", options).map{|post| Kiita::Post.new(post) }
+    end
+
+    def self.search(keyword, options = {})
+      Kiita::API.get("/search", options.merge!(q: keyword)).map{|post| Kiita::Post.new(post) }
+    end
+
+    def self.lazy_load(uuid)
+      new(uuid)
+    end
+
+    def self.find(uuid)
+      new(uuid, Kiita::API.get("/items/#{uuid}").merge!(loaded: true))
+    end
+  end
+end

data/lib/kiita/tag.rb

@@ -0,0 +1,30 @@
+module Kiita
+  class Tag
+    include Kiita::Model
+    attr_reader :url_name
+
+    cattr_reader :attributes
+    @@attributes = %w[name icon_url item_count follower_count following]
+
+    define_attributes @@attributes, -> { Hash.new }
+
+    def initialize(url_name, options = {})
+      if url_name.is_a?(Hash)
+        options = url_name
+        @url_name = options["url_name"]
+      else
+        @url_name = url_name
+      end
+
+      super(options)
+    end
+
+    def posts(options = {})
+      Kiita::API.get("/tags/#{url_name}/items", options).map{|post| Kiita::Post.new(post) }
+    end
+
+    def self.all(options = {})
+      Kiita::API.get("/tags", options).map{|tag| Kiita::Tag.new(tag) }
+    end
+  end
+end

data/lib/kiita/user.rb

@@ -0,0 +1,57 @@
+module Kiita
+  class User
+    include Kiita::Model
+    attr_reader :url_name
+
+    cattr_reader :attributes
+    @@attributes = %w[
+      name profile_image_url url description website_url organization location
+      facebook linkedin twitter github followers following_users items
+    ]
+
+    define_attributes @@attributes, Proc.new{ Kiita::API.get("/users/#{url_name}") }
+
+    def initialize(url_name, options = {})
+      if url_name.is_a?(Hash)
+        options = url_name
+        @url_name = options["url_name"]
+      else
+        @url_name = url_name
+      end
+
+      super(options)
+    end
+
+    def posts(options = {})
+      @posts ||= Kiita::API.get("/users/#{url_name}/items", options).map do |post|
+        Kiita::Post.new(post)
+      end
+    end
+
+    def stocks(options = {})
+      @stocks ||= Kiita::API.get("/users/#{url_name}/stocks", options).map do |post|
+        Kiita::Post.new(post)
+      end
+    end
+
+    def following_users(options = {})
+      @following_users ||= Kiita::API.get("/users/#{url_name}/following_users", options).map do |user|
+        Kiita::User.new(user)
+      end
+    end
+
+    def following_tags(options = {})
+      @following_tags ||= Kiita::API.get("/users/#{url_name}/following_tags", options).map do |tag|
+        Kiita::Tag.new(tag)
+      end
+    end
+
+    def self.lazy_load(url_name)
+      new(url_name)
+    end
+
+    def self.find(url_name)
+      new(url_name, Kiita::API.get("/users/#{url_name}").merge!(loaded: true))
+    end
+  end
+end

data/lib/kiita/version.rb

@@ -0,0 +1,3 @@
+module Kiita
+  VERSION = "0.1.0"
+end

data/spec/kiita/api_spec.rb

@@ -0,0 +1,301 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Kiita::API do
+  def qiita_api_response(path)
+    File.new("#{File.dirname(__FILE__)}/../support/api_responses/#{path}")
+  end
+
+  describe "Initialization" do
+    context "without any options" do
+      subject { Kiita::API.new }
+      it { should be_a Kiita::API }
+      its(:token) { should be_nil }
+    end
+
+    context "without an token option" do
+      subject { Kiita::API.new(token: "token") }
+      its(:token) { should == "token" }
+    end
+  end
+
+  describe "Basic API" do
+    describe "class methods" do
+      describe "#get" do
+        before{ @stub = stub_request(:get, "https://qiita.com/api/v1/?") }
+        after { @stub.should have_been_requested }
+
+        it("makes a get request without token"){ Kiita::API.get("/") }
+      end
+
+      describe "#post" do
+        before{ @stub = stub_request(:post, "https://qiita.com/api/v1/") }
+        after { @stub.should have_been_requested }
+
+        it("makes a post request without token"){ Kiita::API.post("/") }
+      end
+
+      describe "#put" do
+        before{ @stub = stub_request(:put, "https://qiita.com/api/v1/") }
+        after { @stub.should have_been_requested }
+
+        it("makes a put request without token"){ Kiita::API.put("/") }
+      end
+
+      describe "#delete" do
+        before{ @stub = stub_request(:delete, "https://qiita.com/api/v1/") }
+        after { @stub.should have_been_requested }
+
+        it("makes a delete request without token"){ Kiita::API.delete("/") }
+      end
+    end
+
+    describe "instance methods" do
+      describe "#get" do
+        before{ @stub = stub_request(:get, "https://qiita.com/api/v1/?token=token") }
+        after { @stub.should have_been_requested }
+
+        it("makes a get request with token"){ Kiita::API.new(token: "token").get("/") }
+      end
+
+      describe "#post" do
+        before{ @stub = stub_request(:post, "https://qiita.com/api/v1/?token=token") }
+        after { @stub.should have_been_requested }
+
+        it("makes a post request with token"){ Kiita::API.new(token: "token").post("/") }
+      end
+
+      describe "#put" do
+        before{ @stub = stub_request(:put, "https://qiita.com/api/v1/?token=token") }
+        after { @stub.should have_been_requested }
+
+        it("makes a put request with token"){ Kiita::API.new(token: "token").put("/") }
+      end
+
+      describe "#delete" do
+        before{ @stub = stub_request(:delete, "https://qiita.com/api/v1/?token=token") }
+        after { @stub.should have_been_requested }
+
+        it("makes a delete request with token"){ Kiita::API.new(token: "token").delete("/") }
+      end
+    end
+
+    describe "errors" do
+      use_vcr_cassette "qiita/public_apis", record: :new_episodes
+
+      it "raises BadRequest error" do
+        expect{ Kiita::API.post("/auth") }.to raise_exception(Kiita::BadRequest)
+      end
+
+      it "raises NotFound error" do
+        expect{ Kiita::API.get("/notfound") }.to raise_exception(Kiita::NotFound)
+      end
+    end
+  end
+
+  describe "Methods that don't require authentication" do
+    use_vcr_cassette "qiita/public_apis", record: :new_episodes
+
+    describe "#rate_limit" do
+      specify { Kiita::API.rate_limit["remaining"].should be_a Fixnum }
+      specify { Kiita::API.rate_limit["limit"].should be_a Fixnum }
+    end
+
+    describe "#authenticate" do
+      context "with a url name and a password" do
+        before { stub_request(:post, /^https:\/\/qiita.com/).to_return(body: qiita_api_response("auth.json")) }
+        let(:auth_result) { Kiita::API.authenticate("user", "hogehoge") }
+        subject { auth_result }
+        it { should be_a Hash }
+        specify { auth_result["token"].should == "1afb7c91b2a049e1a7981cbd234v5hg" }
+      end
+    end
+
+    describe "#user" do
+      subject { Kiita::API.user("yaotti") }
+      it { should be_a Kiita::User }
+      its(:url_name){ should == "yaotti" }
+      its(:name)    { should == "やおっち/Hiroshige Umino" }
+
+      describe "#posts created by the user" do
+        context "without options" do
+          subject { Kiita::API.user("yaotti").posts }
+          it { should be_an Array }
+          its(:first) { should be_a Kiita::Post }
+        end
+
+        context "page 2 per 10 items" do
+          subject { Kiita::API.user("yaotti").posts(page: 2, per_page: 10) }
+          its(:size) { should == 10 }
+        end
+      end
+
+      describe "#stocks created by the user" do
+        context "without options" do
+          subject { Kiita::API.user("yaotti").stocks }
+          it { should be_an Array }
+          its(:first) { should be_a Kiita::Post }
+        end
+
+        context "page 2 per 10 items" do
+          subject { Kiita::API.user("yaotti").stocks(page: 2, per_page: 10) }
+          its(:size) { should == 10 }
+        end
+      end
+
+      describe "#following_users" do
+        context "without options" do
+          subject { Kiita::API.user("yaotti").following_users }
+          it { should be_an Array }
+          its(:first) { should be_a Kiita::User }
+        end
+
+        context "page 2 per 10 items" do
+          subject { Kiita::API.user("yaotti").following_users(page: 2, per_page: 10) }
+          its(:size) { should == 10 }
+        end
+      end
+
+      describe "#following_tags" do
+        context "without options" do
+          subject { Kiita::API.user("yaotti").following_tags }
+          it { should be_an Array }
+          its(:first) { should be_a Kiita::Tag }
+        end
+
+        context "page 2 per 10 items" do
+          subject { Kiita::API.user("yaotti").following_tags(page: 2, per_page: 10) }
+          its(:size) { should == 10 }
+        end
+      end
+    end
+
+    describe "#post" do
+      subject { Kiita::API.item("2e6258b7c6a5b13b7d16") }
+      it { should be_a Kiita::Post }
+      its(:uuid) { should == "2e6258b7c6a5b13b7d16" }
+      its(:id)   { should == 1408 }
+      its(:title){ should == "インストールされている gem を全て削除する。" }
+    end
+
+    describe "#posts" do
+      context "without options" do
+        subject { Kiita::API.items }
+        it { should be_an Array }
+        its(:first) { should be_a Kiita::Post }
+      end
+
+      context "page 2 per 10 items" do
+        subject { Kiita::API.items(page: 2, per_page: 10) }
+        its(:size) { should == 10 }
+      end
+    end
+
+    describe "#search" do
+      context "without options" do
+        subject { Kiita::API.search("Ruby") }
+        it { should be_an Array }
+        its(:first) { should be_a Kiita::Post }
+      end
+
+      context "page 2 per 10 items" do
+        subject { Kiita::API.search("Ruby", page: 2, per_page: 10) }
+        its(:size) { should == 10 }
+      end
+    end
+
+    describe "#tags" do
+      context "without options" do
+        subject { Kiita::API.tags }
+        it { should be_an Array }
+        its(:first) { should be_a Kiita::Tag }
+      end
+
+      context "page 2 per 10 tags" do
+        subject { Kiita::API.tags(page: 2, per_page: 10) }
+        its(:size) { should == 10 }
+      end
+
+      describe "#posts associated to the tag" do
+        context "without options" do
+          subject { Kiita::API.tag("ruby").posts }
+          it { should be_an Array }
+          its(:first) { should be_a Kiita::Post }
+        end
+
+        context "page 2 per 10 items" do
+          subject { Kiita::API.tag("ruby").posts(page: 2, per_page: 10) }
+          its(:size) { should == 10 }
+        end
+      end
+    end
+  end
+
+  describe "APIs that require authentication" do
+    let(:client) { Kiita::API.new(token: "token") }
+
+    describe "#me" do
+      before { stub_request(:get, /^https:\/\/qiita.com/).to_return(body: qiita_api_response("user.json")) }
+      subject { client.me }
+      it { should be_a Kiita::User }
+      its(:name) { should == "Test User" }
+    end
+
+    describe "#search" do
+      context "with stocked option" do
+        before { stub_request(:get, /^https:\/\/qiita.com/).to_return(body: qiita_api_response("search.json")) }
+        subject { client.search("Ruby", stocked: 'true') }
+        it { should be_an Array }
+        its(:first) { should be_a Kiita::Post }
+      end
+
+      context "with stocked option, page 2 and per 10 items" do
+        before do
+          @stub = stub_request(:get, "https://qiita.com/api/v1/search?page=2&per_page=10&q=Ruby&stocked=true&token=token")
+                    .to_return(body: qiita_api_response("search.json"))
+        end
+        after { @stub.should have_been_requested }
+        it("calls Search API with options"){ client.search("Ruby", stocked: 'true', page: 2, per_page: 10) }
+      end
+    end
+=begin
+    describe "#save a post" do
+    end
+
+    describe "#update a post" do
+    end
+
+    describe "#destroy a post" do
+    end
+=end
+    describe "#stocks" do
+      context "without options" do
+        before { stub_request(:get, /^https:\/\/qiita.com/).to_return(body: qiita_api_response("user_stocks.json")) }
+        subject { client.stocks }
+        it { should be_an Array }
+        its(:first) { should be_a Kiita::Post }
+      end
+
+      context "page 2 per 10 items" do
+        before do
+          @stub = stub_request(:get, "https://qiita.com/api/v1/stocks?page=2&per_page=10&token=token")
+                    .to_return(body: qiita_api_response("user_stocks.json"))
+        end
+        after { @stub.should have_been_requested }
+        it("calls User Stocks API with options"){ client.stocks(page: 2, per_page: 10) }
+      end
+    end
+
+    describe "#stock! a post" do
+      before { stub_request(:put, /^https:\/\/qiita.com/).to_return(body: '') }
+      subject { client.stock!("2e6258b7c6a5b13b7d16") }
+      it { should be_true }
+    end
+
+    describe "#unstock! a post" do
+      before { stub_request(:delete, /^https:\/\/qiita.com/).to_return(body: '') }
+      subject { client.unstock!("2e6258b7c6a5b13b7d16") }
+      it { should be_true }
+    end
+  end
+end

data/spec/kiita/errors_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe Kiita::Errors do
+  # nothing to test
+end

data/spec/kiita/post_spec.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe Kiita::Post do
+  use_vcr_cassette "qiita/item_api", record: :new_episodes
+
+  describe "initialization" do
+    context "with valid attrs" do
+      let(:valid_attrs) do
+        {
+          "id"                  => 1408,
+          "title"               => "インストールされている gem を全て削除する。",
+          "body"                => "I'm a body!",
+          "created_at"          => "2011-12-19 00:04:14 +0900",
+          "updated_at"          => "2012-03-16 11:30:26 +0900",
+          "created_at_in_words" => "10ヶ月前",
+          "updated_at_in_words" => "7ヶ月前",
+          "stock_count"         => 100,
+          "stock_users"         => ["testuser"],
+          "comment_count"       => 100,
+          "url"                 => "http://qiita.com/items/2e6258b7c6a5b13b7d16",
+          "gist_url"            => nil,
+          "private"             => false,
+          "stocked"             => nil
+        }
+      end
+
+      subject { Kiita::Post.new(valid_attrs) }
+      its(:id)                 { should == 1408 }
+      its(:title)              { should == "インストールされている gem を全て削除する。" }
+      its(:body)               { should be_a String }
+      its(:created_at)         { should == "2011-12-19 00:04:14 +0900" }
+      its(:updated_at)         { should == "2012-03-16 11:30:26 +0900" }
+      its(:created_at_in_words){ should include "ヶ月前" }
+      its(:updated_at_in_words){ should include "7ヶ月前" }
+      its(:stock_count)        { should be_a Fixnum }
+      its(:stock_users)        { should be_an Array }
+      its(:comment_count)      { should be_a Fixnum }
+      its(:url)                { should == "http://qiita.com/items/2e6258b7c6a5b13b7d16" }
+      its(:gist_url)           { should be_nil }
+      its(:private)            { should be_false }
+      its(:stocked)            { should be_nil }
+    end
+  end
+
+  describe "#find" do
+    subject { Kiita::Post.find("2e6258b7c6a5b13b7d16") }
+
+    its(:id)                 { should == 1408 }
+    its(:title)              { should == "インストールされている gem を全て削除する。" }
+    its(:body)               { should be_a String }
+    its(:created_at)         { should == "2011-12-19 00:04:14 +0900" }
+    its(:updated_at)         { should == "2012-03-16 11:30:26 +0900" }
+    its(:created_at_in_words){ should include "ヶ月前" }
+    its(:updated_at_in_words){ should include "7ヶ月前" }
+    its(:stock_count)        { should be_a Fixnum }
+    its(:stock_users)        { should be_an Array }
+    its(:comment_count)      { should be_a Fixnum }
+    its(:url)                { should == "http://qiita.com/items/2e6258b7c6a5b13b7d16" }
+    its(:gist_url)           { should be_nil }
+    its(:private)            { should be_false }
+    its(:stocked)            { should be_nil }
+  end
+end