the86-client 0.0.1

data/lib/the86-client/resource_collection.rb

@@ -0,0 +1,66 @@
+module The86::Client
+  class ResourceCollection
+
+    include Enumerable
+
+    # Connection is a The86::Client::Connection instance.
+    # Path is the API-relative path, e.g. "users".
+    # Klass is class of each record in the collection, e.g. User
+    # Attributes is a Hash of attributes common to all items in collection,
+    #   and not fetched in HTTP response, e.g. parent items.
+    #   e.g. for conversations: { site: Site.new(slug: "...") }
+    # Records is an array of hashes, for pre-populating the collection.
+    #   e.g. when an API response contains collections of child resources.
+    def initialize(connection, path, klass, parent, records = nil)
+      @connection = connection
+      @path = path
+      @klass = klass
+      @parent = parent
+      @records = records
+    end
+
+    def build(attributes)
+      @klass.new(attributes.merge(parent: @parent))
+    end
+
+    def create(attributes)
+      build(attributes).tap(&:save)
+    end
+
+    # Find and load a resource.
+    #
+    # If Resource#url_id is overridden, specify the attribute name.
+    # TODO: the resource should know its URL attribute name.
+    #
+    # Note that this currently triggers an HTTP GET, then a POST:
+    #   conversation.find(10).posts.create(attributes)
+    # As an alternative, this only triggers the HTTP POST:
+    #   conversation.build(id: 10).posts.create(attributes)
+    def find(id, attribute = :id)
+      build(id: id).load
+    end
+
+    def each
+      records.each do |attributes|
+        yield build(attributes)
+      end
+    end
+
+    # Cache array representation.
+    # Save building Resources for each record multiple times.
+    def to_a
+      @_to_a = super
+    end
+
+    def [](index)
+      to_a[index]
+    end
+
+    private
+
+    def records
+      @records ||= @connection.get(path: @path, status: 200)
+    end
+
+  end
+end

data/lib/the86-client/site.rb

@@ -0,0 +1,18 @@
+module The86::Client
+  class Site < Resource
+
+    attribute :id, Integer
+    attribute :name, String
+    attribute :slug, String
+    attribute :created_at, DateTime
+    attribute :updated_at, DateTime
+
+    path "sites"
+    has_many :conversations, ->{ Conversation }
+
+    def url_id
+      slug
+    end
+
+  end
+end

data/lib/the86-client/user.rb

@@ -0,0 +1,14 @@
+module The86
+  module Client
+    class User < Resource
+
+      attribute :id, Integer
+      attribute :name, String
+      attribute :created_at, DateTime
+      attribute :updated_at, DateTime
+
+      path "users"
+
+    end
+  end
+end

data/lib/the86-client/version.rb

@@ -0,0 +1,5 @@
+module The86
+  module Client
+    VERSION = "0.0.1"
+  end
+end

data/spec/conversations_spec.rb

@@ -0,0 +1,75 @@
+require_relative "spec_helper"
+
+module The86::Client
+
+  describe "Conversations" do
+
+    describe "listing conversations" do
+      it "returns empty array for site without conversations" do
+        expect_get_conversations(response_body: [])
+        site.conversations.to_a.size.must_equal 0
+      end
+
+      it "returns collection of conversations" do
+        expect_get_conversations(response_body: [{id: 10}, {id: 12}])
+        conversations = site.conversations
+        conversations.to_a.size.must_equal 2
+        c = conversations.first
+        c.must_be_instance_of Conversation
+        c.id.must_equal 10
+        c.site.must_equal site
+      end
+    end
+
+    describe "creating conversations" do
+      it "posts and returns a conversation with the first post content" do
+        expect_request(
+          url: "https://example.org/api/v1/sites/test/conversations",
+          method: :post,
+          status: 201,
+          request_body: {content: "A new conversation."},
+          response_body: {id: 2, posts: [{id: 5, content: "A new conversation."}]},
+          request_headers: {"Authorization" => "Bearer secrettoken"},
+        )
+
+        c = site.conversations.create(
+          content: "A new conversation.",
+          oauth_token: "secrettoken",
+        )
+
+        c.id.must_equal 2
+        posts = c.posts
+        posts.to_a.length.must_equal 1
+        posts[0].content.must_equal "A new conversation."
+      end
+    end
+
+    describe "finding a conversation" do
+      it "gets the conversation, loads data into the resource" do
+        expect_request(
+          url: "https://user:pass@example.org/api/v1/sites/test/conversations/4",
+          method: :get,
+          status: 200,
+          response_body: {id: 4, posts: [{id: 8, content: "A post."}]},
+        )
+        c = site.conversations.find(4)
+        c.id.must_equal 4
+        c.posts.first.content.must_equal "A post."
+      end
+    end
+
+    def site
+      The86::Client.site("test")
+    end
+
+    def expect_get_conversations(options)
+      expect_request({
+        url: "https://user:pass@example.org/api/v1/sites/test/conversations",
+        method: :get,
+        status: 200,
+      }.merge(options))
+    end
+
+  end
+
+end

data/spec/oauth_bearer_authorization_spec.rb

@@ -0,0 +1,19 @@
+require_relative "spec_helper"
+
+module The86::Client
+  describe OauthBearerAuthorization do
+
+    it "sets Authorization header, calls delegate" do
+      env = {request_headers: {}}
+
+      app = MiniTest::Mock.new
+      app.expect(:call, nil, [env])
+
+      OauthBearerAuthorization.new(app, "secret").call(env)
+
+      env[:request_headers]["Authorization"].must_equal "Bearer secret"
+      app.verify
+    end
+
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1,15 @@
+require_relative "spec_helper"
+require "the86-client/post"
+
+module The86::Client
+  describe Post do
+    describe "#reply?" do
+      it "is true when in_reply_to_id is present" do
+        Post.new(in_reply_to_id: 32).reply?.must_equal true
+      end
+      it "is false when in_reply_to_id is not present" do
+        Post.new(in_reply_to_id: nil).reply?.must_equal false
+      end
+    end
+  end
+end

data/spec/posts_spec.rb

@@ -0,0 +1,81 @@
+require_relative "spec_helper"
+
+module The86::Client
+
+  describe Post do
+
+    describe "replying to a post" do
+      it "sends in_reply_to_id" do
+        expect_request(
+          url: "https://example.org/api/v1/sites/test/conversations/32/posts",
+          method: :post,
+          status: 201,
+          request_body: {content: "Hi!", in_reply_to_id: 64},
+          response_body: {
+            id: 96, content: "Hi!", in_reply_to_id: 64, in_reply_to: {
+              id: 64,
+              content: "Hello!",
+              user: {
+                id: 128,
+                name: "Johnny Original"
+              }
+            }
+          },
+          request_headers: {"Authorization" => "Bearer SecretTokenHere"},
+        )
+        post = original_post.reply(
+          content: "Hi!",
+          oauth_token: "SecretTokenHere",
+        )
+        post.conversation.id.must_equal conversation.id
+        post.in_reply_to_id.must_equal original_post.id
+        post.in_reply_to.user.name.must_equal "Johnny Original"
+        post.content.must_equal "Hi!"
+      end
+    end
+
+    describe "following up to a conversation" do
+      it "creates new Post in the Conversation" do
+        expect_request(
+          url: "https://example.org/api/v1/sites/test/conversations/32/posts",
+          method: :post,
+          status: 201,
+          request_body: {content: "+1"},
+          response_body: {id: 96, content: "+1"},
+          request_headers: {"Authorization" => "Bearer SecretTokenHere"},
+        )
+        post = conversation.posts.create(
+          content: "+1",
+          oauth_token: "SecretTokenHere",
+        )
+        post.conversation.id.must_equal conversation.id
+        post.in_reply_to_id.must_equal nil
+        post.content.must_equal "+1"
+      end
+    end
+
+    describe "#user" do
+      let(:post) { Post.new(id: 1, user: {id: 2, name: "John Citizen"}) }
+      it "returns instance of The86::Client::User" do
+        post.user.must_be_instance_of(The86::Client::User)
+      end
+      it "contains the user details" do
+        post.user.name.must_equal "John Citizen"
+      end
+    end
+
+    def original_post
+      Post.new(id: 64, conversation: conversation, content: "Hello!")
+    end
+
+    def conversation
+      Conversation.new(id: 32, site: site)
+    end
+
+    def site
+      The86::Client.site("test")
+    end
+
+  end
+
+end

data/spec/resource_spec.rb

@@ -0,0 +1,32 @@
+require_relative "spec_helper"
+
+module The86::Client
+  describe Resource do
+
+    describe "equality" do
+      resource = Class.new(Resource) do
+        attribute :id, Integer
+        attribute :code, String
+      end
+
+      parent_resource = Class.new(Resource) do
+        attribute :id, Integer
+      end
+
+      it "is equal by attributes" do
+        resource.new(id: 1, code: "A").
+          must_equal resource.new(id: 1, code: "A")
+      end
+
+      it "is inequal by attributes" do
+        resource.new(id: 2, code: "A").
+          wont_equal resource.new(id: 1, code: "A")
+      end
+
+      it "is inequal by parent" do
+        resource.new(code: "A", parent: parent_resource.new(id: 1)).
+          wont_equal resource.new(code: "A", parent: parent_resource.new(id: 2))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "minitest/autorun"
+require "turn"
+
+require_relative "support/webmock"
+
+$LOAD_PATH.unshift "./lib"
+require "the86-client"
+
+The86::Client.domain = "example.org"
+The86::Client.credentials = ["user", "pass"]

data/spec/support/webmock.rb

@@ -0,0 +1,41 @@
+require "json"
+require "webmock/minitest"
+
+WebMock.disable_net_connect!
+
+##
+# WebMock request expectations.
+module RequestExpectations
+
+  def self.included(klass)
+    klass.before { @expected_requests = [] }
+    klass.after { @expected_requests.each { |sr| assert_requested(sr) } }
+  end
+
+  def stub_and_assert_request(*parameters)
+    stub_request(*parameters).tap do |request|
+      @expected_requests << request
+    end
+  end
+
+  def expect_request(options)
+    url = options.fetch(:url)
+    method = options.fetch(:method)
+    request_body = options[:request_body]
+    response_body = options[:response_body]
+    request_headers = options[:request_headers]
+
+    request = {}
+    request[:body] = request_body if request_body
+    request[:headers] = request_headers if request_headers
+
+    response = {status: options[:status] || 200}
+    response[:body] = JSON.generate(response_body) if response_body
+
+    stub_and_assert_request(method, url).
+      with(request).
+      to_return(response)
+  end
+end
+
+MiniTest::Spec.send(:include, RequestExpectations)

data/spec/users_spec.rb

@@ -0,0 +1,78 @@
+require_relative "spec_helper"
+
+module The86::Client
+
+  describe "Users" do
+
+    describe "creating a user" do
+      it "is successful with 200 OK" do
+        expect_create_user(response_body: {id: 1, name: "John Appleseed"})
+        user = The86::Client.users.create(name: "John Appleseed")
+        user.id.must_be_instance_of Fixnum
+        user.name.must_equal "John Appleseed"
+      end
+
+      it "raises error for 200 OK" do
+        expect_create_user(status: 200, response_body: {id: 1, name: "John Appleseed"})
+        ->{ The86::Client.users.create(name: "John Appleseed") }.must_raise Error
+      end
+
+      it "raises ValidationFailed for 422 response" do
+        expect_create_user(status: 422, request_body: {name: ""})
+        ->{ The86::Client.users.create(name: "") }.must_raise ValidationFailed
+      end
+
+      it "raises Unauthorized for 401 response" do
+        expect_create_user(status: 401, request_body: {name: "Test"})
+        ->{ The86::Client.users.create(name: "Test") }.must_raise Unauthorized
+      end
+    end
+
+    describe "updating a user (may not be supported by server)" do
+      it "PATCHes users/:id" do
+        time_before = DateTime.now - 86400
+        time_after = DateTime.now
+        expect_request(
+          url: "https://user:pass@example.org/api/v1/users/5",
+          method: :patch,
+          status: 200,
+          request_body: {name: "New Name"},
+          response_body: {id: 5, name: "New Name", updated_at: time_after}
+        )
+        user = User.new(
+          id: 5,
+          name: "Old Name",
+          updated_at: time_before
+        )
+        user.name = "New Name"
+        user.updated_at.to_s.must_equal time_before.to_s
+        user.save
+        user.updated_at.to_s.must_equal time_after.to_s
+      end
+    end
+
+    describe "listing users (may not be supported by server)" do
+      it "returns collection of users" do
+        expect_request(
+          url: "https://user:pass@example.org/api/v1/users",
+          method: :get,
+          status: 200,
+          response_body: [{id: 4, name: "Paul"}, {id: 8, name: "James"}]
+        )
+        users = The86::Client.users
+        users.to_a.length.must_equal 2
+        users.first.name.must_equal "Paul"
+      end
+    end
+
+    def expect_create_user(options = {})
+      expect_request({
+        url: "https://user:pass@example.org/api/v1/users",
+        method: :post,
+        status: 201,
+      }.merge(options))
+    end
+
+  end
+
+end