Initial

Bennett Goble · Bennett Goble · commit 7e2120efe19d · 2014-04-10T18:19:35.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.bundle/
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    cortex-client (0.0.1)
+      faraday (~> 0.8.9)
+      faraday_middleware (~> 0.9.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    multipart-post (1.2.0)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cortex-client!
+  rake
+  rspec
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 CareerBuilder, LLC
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+# cortex-client
+Ruby client library for [cortex](https://github.com/cb-talent-development/cortex)'s API.
+
+cortex-client does not handle fetching or refreshing an OAuth access_token. For this use a library such as [OAuth](http://oauth.rubyforge.org/).
+
+```ruby
+require 'cortex-client'
+
+client = Cortex::Client.new(access_token)
+
+client.posts.query().each do |post|
+  puts post
+end
+```
+
+### Supported Endpoints
+
+- *Users* - me, get ,save
+- *Posts* - query, get, save, delete
+
+### TODO
+- Handle pagination
+- Support for search queries
+- /media
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,8 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
diff --git a/cortex-client.gemspec b/cortex-client.gemspec
@@ -0,0 +1,21 @@
+# encoding: utf-8
+require './lib/cortex/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'cortex-client'
+  s.version       = Cortex::VERSION
+  s.summary       = 'Cortex API Client'
+  s.homepage      = 'https://github.com/cb-talent-development/cortex-client'
+  s.authors       = ['Bennett Goble']
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/).reject { |f| f == '.gitignore' }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  s.add_dependency 'faraday', '~> 0.8.9'
+  s.add_dependency 'faraday_middleware', '~> 0.9.0'
+end
diff --git a/lib/cortex-client.rb b/lib/cortex-client.rb
@@ -0,0 +1,2 @@
+require 'cortex/client'
+require 'cortex/version'
diff --git a/lib/cortex/client.rb b/lib/cortex/client.rb
@@ -0,0 +1,22 @@
+require 'cortex/connection'
+require 'cortex/request'
+require 'cortex/resource'
+require 'cortex/posts'
+require 'cortex/users'
+
+module Cortex
+  class Client
+    attr_reader :posts, :users
+    attr_accessor :access_token, :base_url
+
+    include Cortex::Connection
+    include Cortex::Request
+
+    def initialize(access_token, base_url = 'https://cbcortex.com/api/v1')
+      @access_token = access_token
+      @base_url = base_url
+      @posts = Cortex::Posts.new(self)
+      @users = Cortex::Users.new(self)
+    end
+  end
+end
diff --git a/lib/cortex/connection.rb b/lib/cortex/connection.rb
@@ -0,0 +1,21 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Cortex
+  module Connection
+    def connection
+      options = {
+        :headers => {
+          :user_agent => "cortex-client (Ruby) - #{Cortex::VERSION}"
+        },
+        :url => base_url
+      }
+      Faraday.new options do |conn|
+        conn.request :oauth2, access_token
+        conn.request :json
+        conn.response :json, :content_type => /\bjson$/
+        conn.adapter Faraday.default_adapter
+      end
+    end
+  end
+end
diff --git a/lib/cortex/posts.rb b/lib/cortex/posts.rb
@@ -0,0 +1,19 @@
+module Cortex
+  class Posts  < Cortex::Resource
+    def query
+      client.get('/posts')
+    end
+
+    def get(id)
+      client.get("/posts/#{id}")
+    end
+
+    def save(post)
+      client.save('/posts', post)
+    end
+
+    def delete(id)
+      client.delete("/posts/#{id}")
+    end
+  end
+end
diff --git a/lib/cortex/request.rb b/lib/cortex/request.rb
@@ -0,0 +1,59 @@
+require 'ostruct'
+
+module Cortex
+  module Request
+    def get(path, params = {})
+      response = connection.get do |r|
+        r.url base_url + path
+        r.params = params
+      end
+      parse_response(response)
+    end
+
+    def post(path, params = {})
+      response = connection.post do |r|
+        r.url base_url + path
+        r.body = params unless params.empty?
+      end
+      parse_response(response)
+    end
+
+    def put(path, params = {})
+      response = connection.put do |r|
+        r.url base_url + path
+        r.body = params unless params.empty?
+      end
+      parse_response(response)
+    end
+
+    def delete(path)
+      response = connection.delete do |r|
+        r.url base_url + path
+      end
+      response.status < 300
+    end
+
+    def delete!(path)
+      response = connection.delete do |r|
+        r.url base_url + path
+      end
+      if response.status < 300
+        true
+      else
+        raise parse_response(response)
+      end
+    end
+
+    def save(path, model)
+      model[:id] ? put("#{path}/#{model[:id]}", model) : post(path, model)
+    end
+
+    def parse_response(response)
+      if response.status < 300 || (response.body.kind_of?(Hash) && response.body['error'])
+        response.body
+      else
+        OpenStruct.new({:error => response.body, :status => response.status, :original => response})
+      end
+    end
+  end
+end
diff --git a/lib/cortex/resource.rb b/lib/cortex/resource.rb
@@ -0,0 +1,10 @@
+module Cortex
+  class Resource
+    def initialize(client)
+      @client = client
+    end
+
+    protected
+    attr_accessor :client
+  end
+end
diff --git a/lib/cortex/users.rb b/lib/cortex/users.rb
@@ -0,0 +1,15 @@
+module Cortex
+  class Users < Cortex::Resource
+    def me
+      client.get('/users/me')
+    end
+
+    def get(id)
+      client.get("/users/#{id}")
+    end
+
+    def save(user)
+      client.save('/users', user)
+    end
+  end
+end
diff --git a/lib/cortex/version.rb b/lib/cortex/version.rb
@@ -0,0 +1,3 @@
+module Cortex
+  VERSION = '0.0.1'
+end
diff --git a/spec/client_spec.rb b/spec/client_spec.rb
@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Cortex::Client do
+
+  let(:access_token) { '123' }
+  let(:base_url) { 'http://localhost:3000' }
+  let(:client) do
+    Cortex::Client.new(access_token, base_url)
+  end
+
+  it 'should preserve settings' do
+    client.access_token.should == access_token
+    client.base_url.should == base_url
+  end
+end
diff --git a/spec/posts_spec.rb b/spec/posts_spec.rb
@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Cortex::Posts do
+
+  let(:client) { Cortex::Client.new('123') }
+
+  describe :get do
+    it 'should correctly make the request' do
+      client.should_receive(:get).with('/posts/1').and_return('response')
+      client.posts.get(1).should == 'response'
+    end
+  end
+
+  describe :save do
+    context 'with an existing post' do
+      it 'should correctly make the request' do
+        post = {:id => 1, :title => 'Post'}
+        client.should_receive(:put).with('/posts/1', post).and_return('response')
+        client.posts.save(post).should == 'response'
+      end
+    end
+
+    context 'with a new post' do
+      it 'should correctly make the request' do
+        post = {:title => 'Post'}
+        client.should_receive(:post).with('/posts', post).and_return('response')
+        client.posts.save(post).should == 'response'
+      end
+    end
+  end
+end
diff --git a/spec/request_spec.rb b/spec/request_spec.rb
@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Cortex::Request do
+  let(:client) { Cortex::Client.new('123') }
+
+  context 'with a cortex error response' do
+    it 'should return the error object' do
+      body = {'error' => 'Validation error or something'}
+      response = OpenStruct.new(:status => 422, :body => body)
+      client.parse_response(response).should == body
+    end
+  end
+
+  context 'with a non-cortex error response' do
+    it 'should return a wrapped response' do
+      body = 'Catastrophic error'
+      response = OpenStruct.new(:status => 500, :body => body)
+      parsed = client.parse_response(response)
+      parsed.error.should == body
+      parsed.status.should == 500
+      parsed.original.should == response
+    end
+  end
+
+  context 'with a successful response' do
+    it 'should return the parsed body' do
+      body = {:id => 1, title: 'A post'}
+      response = OpenStruct.new(:status => 200, :body => body)
+      client.parse_response(response).should == body
+    end
+  end
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -0,0 +1,2 @@
+require 'ostruct'
+require_relative '../lib/cortex-client'
diff --git a/spec/users_spec.rb b/spec/users_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+source 'https://rubygems.org'`
	`2`	`+`
	`3`	`+gemspec`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+require 'cortex/client'`
	`2`	`+require 'cortex/version'`