tijuana_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1f9f72c08ac31d5156315feb611afe9ab7b4dfb
+  data.tar.gz: ef8e20b19e777ffeff731f085fbcfe73a39396de
+SHA512:
+  metadata.gz: 6d4b80e21984aa5aa997ba9eed1d0e1f344e01d0b9a14beac40270540d0f1f324543a57a9b241a92175d8ee088a0d1410883ba8259eddeb523c6e92006bf7b5a
+  data.tar.gz: 7aca41644f92d8608b9639b6c1561d917e908bc729b62a7b1d44b55b22d2e3ff2c462ea8d837eaef76552c52cfc9954d39286984e5845d8d595d7b60fac90d0c

data/.ruby-gemset

@@ -0,0 +1 @@
+tijuana_client

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p247

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem 'vertebrae'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem 'webmock'
+  gem 'pry'
+  gem 'pry-debugger'
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,108 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.10)
+    builder (3.2.2)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    crack (0.4.0)
+      safe_yaml (~> 0.9.0)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.7)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    git (1.2.5)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    i18n (0.6.4)
+    jeweler (1.8.6)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.1)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.2)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    safe_yaml (0.9.4)
+    slop (3.4.5)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+    vertebrae (0.1.6)
+      activesupport
+      faraday
+      faraday_middleware
+      hashie
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.4)
+  pry
+  pry-debugger
+  rspec
+  vertebrae
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 ControlShift Ltd.
+
+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,4 @@
+tijuana_client_
+=========================
+
+An exceptionally simple client for Getup's Tijuana

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tijuana_client"
+  gem.homepage = "http://github.com/controlshift/tijuana_client"
+  gem.license = "MIT"
+  gem.summary = %Q{API client for Tijuana}
+  gem.description = %Q{An API client for the code that runs Getup.org.au}
+  gem.email = "nathan@controlshiftlabs.com"
+  gem.authors = ["Nathan Woodhull"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "porpoise_external_actions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/tijuana_client/base.rb

@@ -0,0 +1,60 @@
+module TijuanaClient
+  class Base < Vertebrae::API
+    def normalized_base_path
+      "/api/#{base_path}/"
+    end
+
+    def post_json_request(path, params)
+      p = {}
+      p['data'] = params.to_json
+      post_request(path, p)
+    end
+
+    def request(method, path, params, options) # :nodoc:
+      if !::Vertebrae::Request::METHODS.include?(method)
+        raise ArgumentError, "unknown http method: #{method}"
+      end
+
+      conn = connection(options.merge(current_options))
+      path =  conn.path_prefix + '/' + path
+
+      ::Vertebrae::Base.logger.debug "EXECUTED: #{method} - #{path} with #{params} and #{options}"
+
+      conn.send(method) do |request|
+
+        case method.to_sym
+          when *(::Vertebrae::Request::METHODS - ::Vertebrae::Request::METHODS_WITH_BODIES)
+            request.body = params.delete('data') if params.has_key?('data')
+            request.url(path, params)
+          when *::Vertebrae::Request::METHODS_WITH_BODIES
+            request.path = path
+            request.body = extract_data_from_params(params) unless params.empty?
+        end
+      end
+    end
+
+    def default_middleware(options={})
+      Proc.new do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Vertebrae::Request::BasicAuth, authentication if authenticated?
+
+        builder.use Faraday::Response::Logger if ENV['DEBUG']
+
+        builder.use Vertebrae::Response::RaiseError
+        builder.adapter adapter
+      end
+    end
+
+    private
+
+    def extract_data_from_params(params)
+      if params.has_key?('data') && params['data'].present?
+        return "data=#{params['data']}"
+      else
+        return params
+      end
+    end
+
+  end
+end

data/lib/tijuana_client/client.rb

@@ -0,0 +1,7 @@
+module TijuanaClient
+  class Client < Vertebrae::API
+    def user(options={}, &block)
+      @user ||= TijuanaClient::User.new(current_options.merge(options), &block)
+    end
+  end
+end

data/lib/tijuana_client/configuration.rb

@@ -0,0 +1,11 @@
+module TijuanaClient
+  module Configuration
+    def self.included(mod)
+      Vertebrae::Base.configure do |config|
+        config.user_agent = 'TijuanaClient'
+        config.prefix = ''
+        config.content_type = 'application/x-www-form-urlencoded'
+      end
+    end
+  end
+end

data/lib/tijuana_client/user.rb

@@ -0,0 +1,11 @@
+module TijuanaClient
+  class User < Base
+    def base_path
+      'users'
+    end
+
+    def create(params)
+      post_json_request(normalized_base_path, params)
+    end
+  end
+end

data/lib/tijuana_client.rb

@@ -0,0 +1,16 @@
+require 'vertebrae'
+require 'tijuana_client/configuration'
+require 'tijuana_client/base'
+require 'tijuana_client/user'
+require 'tijuana_client/client'
+
+module TijuanaClient
+  extend Vertebrae::Base
+  include TijuanaClient::Configuration
+
+  class << self
+    def new(options = {}, &block)
+      TijuanaClient::Client.new(options, &block)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TijuanaClient::Client do
+  specify { subject.should respond_to :user }
+
+  describe "instantiated" do
+    subject { described_class.new(options) }
+
+    context 'process_basic_auth' do
+      let(:options) { { :basic_auth => 'login:password' } }
+      its(:username) { should eq 'login' }
+      its(:password) { should eq 'password' }
+      its(:basic_auth) { should eq 'login:password' }
+    end
+
+    context "process username & password" do
+      let(:options) { { :username => 'login', password: 'password' } }
+      its(:username) { should eq 'login' }
+      its(:password) { should eq 'password' }
+      its(:basic_auth) { should eq 'login:password' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'tijuana_client'
+require 'webmock/rspec'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+
+RSpec.configure do |config|
+  config.include WebMock::API
+
+
+  config.before(:each) do
+    WebMock.reset!
+  end
+  config.after(:each) do
+    WebMock.reset!
+  end
+
+end
+
+def stub_get(path)
+  stub_tijuana_request(:get, path)
+end
+
+def stub_post(path)
+  stub_tijuana_request(:post, path)
+end
+
+def stub_tijuana_request(method, path)
+  prefix = TijuanaClient.prefix.to_s
+  stub_request(method, "https://test.com" + prefix + path)
+end
+
+def reset_authentication_for(object)
+  [ 'username', 'password' ].each do |item|
+    TijuanaClient.send("#{item}=", nil)
+    object.send("#{item}=", nil)
+  end
+end
+
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, '/', file))
+end

data/spec/tijuana_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TijuanaClient do
+  specify { subject.should respond_to :user }
+  specify { subject.new.should be_a(TijuanaClient::Client)}
+end

data/spec/user_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TijuanaClient::User do
+  subject { TijuanaClient.new(host: 'test.com') }
+
+  describe 'configuration' do
+    it 'should propagate the host to the page' do
+      subject.user.host.should == 'test.com'
+    end
+  end
+
+  describe '.post_json_request' do
+    subject { TijuanaClient::User.new({}) }
+    let(:path) { '/foo' }
+    let(:params) { {first_name: 'Nathan'} }
+
+    it "should jsonify params" do
+       subject.should_receive(:post_request).with('/foo', {'data' => JSON.generate({ first_name: 'Nathan'}) } )
+       subject.post_json_request(path, params)
+    end
+  end
+
+  describe "create" do
+    let(:body) { "" }
+    let(:request_body) { "data=#{ JSON.generate({ first_name: 'Nathan'})}" }
+    let(:request_path) { '/api/users/' }
+
+    before(:each) do
+      stub_post(request_path).with(body: request_body).to_return(:body => body, :status => status,
+                                                                 :headers => { content_type: "application/json; charset=utf-8"})
+    end
+
+    describe "success" do
+      let(:status) { 200 }
+
+      it "should create a user" do
+        subject.user.create(first_name: 'Nathan')
+      end
+    end
+
+    describe "an error" do
+      let(:status) { 500 }
+
+      it "should return nil" do
+        lambda { subject.user.create(first_name: 'Nathan') }.should raise_exception
+      end
+    end
+  end
+
+  describe "basic authentication" do
+    subject { TijuanaClient.new(host: 'test.com', username: 'username', password: 'password')}
+
+    let(:body) { "" }
+    let(:request_body) { "data=#{ JSON.generate({ first_name: 'Nathan'})}" }
+    let(:request_path) { '/api/users/' }
+
+    before(:each) do
+      stub_request(:post, "https://username:password@test.com#{request_path}").with(body: request_body).to_return(:body => body, :status => status,
+                                                                 :headers => { content_type: "application/json; charset=utf-8"})
+    end
+
+    describe "success" do
+      let(:status) { 200 }
+
+      it "should create a user" do
+        subject.user.create(first_name: 'Nathan')
+      end
+    end
+
+    describe "unauthorized" do
+      let(:status) { 401 }
+
+      it "should return nil" do
+        lambda { subject.user.create(first_name: 'Nathan') }.should raise_exception
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: tijuana_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Woodhull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vertebrae
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: An API client for the code that runs Getup.org.au
+email: nathan@controlshiftlabs.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/tijuana_client.rb
+- lib/tijuana_client/base.rb
+- lib/tijuana_client/client.rb
+- lib/tijuana_client/configuration.rb
+- lib/tijuana_client/user.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- spec/tijuana_spec.rb
+- spec/user_spec.rb
+homepage: http://github.com/controlshift/tijuana_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.4
+signing_key: 
+specification_version: 4
+summary: API client for Tijuana
+test_files: []