stretchr 1.0.0 → 1.2.2

data/test/stubs/post_single_object.json

@@ -0,0 +1,8 @@
+{
+    "~changes":
+        {
+            "~created":1,
+            "~deltas":[{"~id":"id-here"}]
+        },
+    "~status":201
+}

data/test/test_bag.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+describe "Param Bag" do
+	it "should let me set basic parameters" do
+		b = Stretchr::Bag.new
+		b.set("param", "value")
+		assert_equal "value", b.get("param")
+	end
+
+	it "Should let you merge parameters into a query string" do
+		b = Stretchr::Bag.new
+		b.set("include", "~parent")
+		b.set("key", "asdf")
+		assert_equal "include=~parent&key=asdf", URI.decode(b.query_string), "Should let you create a query string"
+	end
+
+	it "Should let me specify a key to start the bag with" do
+		b = Stretchr::Bag.new({prefix: ":"})
+		b.set("age", "21")
+		assert_equal "21", b.get("age"), "Should have set the age"
+		assert_equal ":age=21", URI.decode(b.query_string), "Should have added a prefix to the bag"
+	end
+end

data/test/test_client.rb

@@ -1,132 +1,55 @@
-require 'test/unit'
 require 'test_helper.rb'
 
-class StretchrTest < Test::Unit::TestCase
-
-	def test_new_with_missing_fields
-		assert_raise Stretchr::MissingAttributeError do
-			stretchr = Stretchr::Client.new({})
-		end
-		assert_raise Stretchr::MissingAttributeError do
-			stretchr = Stretchr::Client.new({public_key: "test", project: "project.company"})
-		end
-		assert_raise Stretchr::MissingAttributeError do
-			stretchr = Stretchr::Client.new({private_key: 'ABC123-private', project: "project.company"})
-		end
-		assert_raise Stretchr::MissingAttributeError do
-			stretchr = Stretchr::Client.new({private_key: 'ABC123-private', public_key: "test"})
-		end
-
-	end
-
-	def test_new_defaults
-
-		stretchr = test_stretchr_object
-		assert_not_nil stretchr.signatory, "stretchr.signatory"
-		assert_not_nil stretchr.transporter, "stretchr.transporter"
-
-	end
-
-	def test_new_custom_transporter
-
+describe "Client" do
+	it "Should let you pass in the transporter you want" do
 		transporter = Object.new
-		stretchr = Stretchr::Client.new({transporter: transporter, private_key: 'ABC123-private', public_key: "test", project: "project.company"})
-		assert_equal transporter, stretchr.transporter
-
+		stretchr = Stretchr::Client.new({transporter: transporter})
+		assert_equal transporter, stretchr.transporter, "Should have let me pass in a transporter"
 	end
 
-	def test_new_custom_signatory
-
-		signatory = Object.new
-		stretchr = Stretchr::Client.new({signatory: signatory, private_key: 'ABC123-private', public_key: "test", project: "project.company"})
-		assert_equal signatory, stretchr.signatory
-
+	it "Should return a request object whenever you try to do something" do
+		stretchr = Stretchr::Client.new
+		r = stretchr.people
+		assert_equal Stretchr::Request, r.class, "Should have returned a request object"
+		assert_equal "people", r.path, "Should have started building the url"
 	end
 
-	def test_make_request
-
-		stretchr = test_stretchr_object
-		stretchr.people(123).books
-		
-		stretchr.http_method = :get
-
-		request = stretchr.generate_request
-
-		assert_equal true, request.is_a?(Stretchr::Request)
-
-		assert_equal(stretchr.http_method, request.http_method)
-		assert_equal(stretchr.signed_uri, request.signed_uri)
-
+	it "Should let you specify the version of the api you want to work with" do
+		stretchr = Stretchr::Client.new({api_version: "1.1"})
+		assert_equal "1.1", stretchr.api_version, "Should let me specify the api version that I want"
 	end
 
-	def test_basic_url_generation
-		stretchr = test_stretchr_object
-		assert_equal URI.parse("http://project.company.stretchr.com/api/v1/people/1/cars").to_s, stretchr.people(1).cars.to_url
+	it "Should let me specify the project and key" do
+		stretchr = Stretchr::Client.new({project: "asdf", key: "asdf2"})
+		assert_equal "asdf", stretchr.project, "Should have let me pass in the project"
+		assert_equal "asdf2", stretchr.key, "Should have let me pass in the key"
 	end
 
-	def test_paging
-		stretchr = test_stretchr_object
-		stretchr.people.limit(10).skip(10)
-		assert_equal true, stretchr.uri.validate_param_value("~limit", "10"), "limit not set"
-		assert_equal true, stretchr.uri.validate_param_value("~skip", "10"), "skip not set"
-
-		stretchr = test_stretchr_object
-		stretchr.people.limit(10).page(2)
-		assert_equal true, stretchr.uri.validate_param_value("~limit", "10"), "limit not set"
-		assert_equal true, stretchr.uri.validate_param_value("~skip", "10"), "skip not set"
+	it "Should pass the client to the request" do
+		stretchr = Stretchr::Client.new({project: "asdf", api_version: "v1.1"})
+		r = stretchr.people
+		assert_equal stretchr, r.client, "Should have passed the client into the request"
 	end
 
-	def test_orders
-		stretchr = test_stretchr_object
-		stretchr.people.order("-age")
-		assert_equal true, stretchr.uri.validate_param_value("~order", "-age")
-
-		stretchr = test_stretchr_object
-		stretchr.people.order("-age,name")
-		assert_equal true, stretchr.uri.validate_param_value("~order", "-age,name")
+	it "Should have a default api_version" do
+		stretchr = Stretchr::Client.new
+		assert stretchr.api_version, "Should have set a default api version"
 	end
 
-	def test_configuration_setup
-		Stretchr.config do |s|
-			s.private_key = "test_private"
-			s.public_key = "test_public"
-			s.project = "test"
-		end
-
-		assert_equal Stretchr.instance_eval {@configuration.private_key}, "test_private", "Should have setup configuration for the module"
-		assert_nothing_raised do
-			client = Stretchr::Client.new
-		end
-
-		assert_raise Stretchr::UnknownConfiguration, "Should raise an error when we pass an unknown configuration in" do
-			Stretchr.config do |s|
-				s.fake_param = "what"
-			end
-		end
-		#FIXME : this is a hack to reset the client!
-		Stretchr.instance_eval {@configuration = Stretchr::Configuration.new}
+	it "Should let me specify the hostname I want" do
+		stretchr = Stretchr::Client.new({hostname: "ryon.com"})
+		assert_equal "ryon.com", stretchr.hostname, "Should have let me specify the hostname I want"
 	end
 
-	def test_client_shouldnt_expect_options
-		assert_nothing_raised do
-			client = Stretchr::Client.new(nil)
-		end
+	it "Should default to the stretchr hostname" do
+		stretchr = Stretchr::Client.new
+		assert_equal 'stretchr.com', stretchr.hostname, "Should have defaulted to the correct hostname"
 	end
 
-	def test_client_should_raise_errors
-		stretchr = test_stretchr_object
-		stretchr.noisy_errors = true
-		assert_raises Stretchr::NotFound, "Should have returned not found!" do
-			stretchr.transporter.responses << Stretchr::Response.new({json: ({"~s" => 404}).to_json})
-			stretchr.get
-		end
+	it "Should set a default transporter if I don't" do
+		stretchr = Stretchr::Client.new
+		assert_equal Stretchr::JSONTransporter, stretchr.transporter.class, "Should have defaulted to JSON transport"
 	end
 
-	def test_query
-		stretchr = test_stretchr_object
-		stretchr.where("name" => "ryan", "age" => ">21")
-		assert stretchr.uri.validate_param_value(":name", "ryan"), "Should have searched for a name"
-		assert stretchr.uri.validate_param_value(":age", ">21"), "Should search for an age"
-	end
 
 end

data/test/test_config.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+describe "Load Config" do
+	it "Should load the config file for you" do
+		assert_equal "~status", Stretchr.config["v1.1"]["status"], "Should have loaded the config file"
+	end
+end

data/test/test_helper.rb

@@ -1,59 +1,9 @@
 require "cgi" unless defined? CGI
 require_relative "../lib/stretchr"
+require "minitest/autorun"
 
-def test_stretchr_object
-  Stretchr::Client.new({transporter: Stretchr::TestTransporter.new, private_key: 'ABC123-private', public_key: "test", project: "project.company"})
-end
-
-module Stretchr
-	class GenerateResponse
-		class << self
-			def get_single_response(params = {})
-				response = {
-					"~s" => params[:status] || 200,
-					"~d" => params[:data],
-				}
-				response["~e"] = params[:errors] if params[:errors]
-				response["~x"] = params[:context] if params[:context]
-				response["~ch"] = params[:change_info] if params[:change_info]
-				response.to_json
-			end
-
-			def get_collection_response(params = {})
-				response = {
-					"~s" => params[:status] || 200,
-					"~d" => {
-							"~t" => params[:total] || 10,
-							"~c" => params[:in_response] || 0
-						},
-				}
-				if params[:objects]
-					response["~d"]["~i"] = params[:objects]
-					response["~d"]["~c"] = params[:objects].length
-				end
-				response["~e"] = params[:errors] if params[:errors]
-				response["~x"] = params[:context] if params[:context]
-				response["~ch"] = params[:change_info] if params[:change_info]
-				response.to_json
-			end
-
-			def post_response(params = {})
-				response = {
-					"~s" => params[:status] || 200,
-					"~ch" => {"~c" => 1, "~u" => 1, "~d" => 0 }
-				}
-				response["~ch"]["~deltas"] = params[:deltas] if params[:deltas]
-				response.to_json
-			end
-
-			def put_response(params = {})
-				{
-
-				}
-			end
-
-		end
-	end
+def load_api_response(filename)
+	File.open(File.join(Dir.pwd, "test", "stubs", filename)) {|f| f.read }
 end
 
 module URI

data/test/test_request.rb

@@ -0,0 +1,184 @@
+require "test_helper"
+
+describe "Request Object" do
+	it "Should let you build up a url" do
+		r = Stretchr::Request.new
+		r.people(1).cars
+		assert_equal "people/1/cars", r.path, "Should have built up a path"
+	end
+
+	it "Should know how to build a complete url including path" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		assert_equal "http://project.stretchr.com/api/v1.1/people/1/cars", r.people(1).cars.to_url, "Should have built the url properly"
+	end
+
+	it "Should let you pass in params" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.param("key", "asdf")
+		assert r.to_url.include?("?key=asdf"), "Should have added the params"
+	end
+
+	it "should let you chain params" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.param("key", "asdf").param("key2", "asdf2")
+		uri = r.to_uri
+		assert_equal "asdf", uri.get_param("key").first, "should have set key"
+		assert_equal "asdf2", uri.get_param("key2").first, "Should have set key2"
+	end
+
+	it "should let you add filters" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.where("name", "ryan").where("age", "21")
+		assert_equal ["ryan"], r.to_uri.get_param(":name"), "Should have added filters"
+		assert_equal ["21"], r.to_uri.get_param(":age"), "Should have added filter for age"
+	end
+
+	it "Should let you add multiple filters" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.where("age", [">21", "<40"])
+		assert_equal [">21", "<40"], r.to_uri.get_param(":age"), "Should have added multiple ages"
+	end
+
+	it "Should let you get objects" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.get
+		assert_equal :get, t.requests.first[:method], "Should have performed a get request"
+	end
+
+	it "Should let you create new objects" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.create({name: "ryan"})
+		assert_equal :post, t.requests.first[:method], "Should have performed a post"
+		assert_equal "ryan", t.requests.first[:body][:name], "Should have sent the body to the transporter"
+	end
+
+	it "Should let you replace an existing object" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people(1).replace({name: "ryan"})
+		assert_equal :put, t.requests.first[:method], "Should have performed a put"
+		assert_equal "ryan", t.requests.first[:body][:name], "Should have sent the body to the transporter"
+	end
+
+	it "Should let you update an existing object" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people(1).update({name: "ryan"})
+		assert_equal :patch, t.requests.first[:method], "Should have performed a put"
+		assert_equal "ryan", t.requests.first[:body][:name], "Should have sent the body to the transporter"
+	end
+
+	it "Should let you remove an object or collection" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people(1).remove
+		assert_equal :delete, t.requests.first[:method], "Should have performed a put"
+	end
+
+	it "Should set a default api version" do
+		r = Stretchr::Request.new
+		assert r.api_version, "it should have set a default api version"
+	end
+
+	it "Should let me pass in a client" do
+		client = Object.new
+		r = Stretchr::Request.new({client: client})
+		assert_equal client, r.client, "Should have passed the client to the request"
+	end
+
+	it "Should pass the client to the transporter" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.get
+		assert_equal c, t.requests.first[:client], "Should have passed the client to the transporter"
+	end
+
+	it "should pass the correct uri to the transporter" do
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.get
+		assert_equal "http://project.stretchr.com/api/v1.1/people", r.to_url, "Should have saved the right url in the request"
+		assert_equal "http://project.stretchr.com/api/v1.1/people", t.requests.first[:uri].to_s, "Should have created the right URL and sent it to the transporter"
+	end
+
+	it "Should know how to handle paging" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.people.limit(10).skip(10)
+		assert r.to_uri.validate_param_value("limit", "10"), "should have added limit"
+		assert r.to_uri.validate_param_value("skip", "10"), "should have added skip"
+
+		r2 = Stretchr::Request.new({client: c})
+		r2.people.limit(10).page(2)
+		assert r2.to_uri.validate_param_value("limit", "10"), "should have added limit"
+		assert r2.to_uri.validate_param_value("skip", "10"), "should have added skip from paging"
+	end
+
+	it "Should understand how to do ordering" do
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1"})
+		r = Stretchr::Request.new({client: c})
+		r.order("-name,age")
+		assert r.to_uri.validate_param_value("order", "-name,age"), "should have added order attribute"
+	end
+
+	it "Should support the necessary convenience methods" do
+		# READ/GET
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.get
+		assert_equal :get, t.requests.first[:method], "Should have performed a get request"
+		r.people.read
+		assert_equal :get, t.requests[1][:method], "Should have performed a get request"
+
+		# REPLACE/PUT
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.replace({name: "ryan"})
+		assert_equal :put, t.requests.first[:method], "Should have performed a put request"
+		r.people.put({name: "ryan"})
+		assert_equal :put, t.requests[1][:method], "Should have performed a put request"
+
+		# UPDATE/PATCH
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.update({name: "ryan"})
+		assert_equal :patch, t.requests.first[:method], "Should have performed a patch request"
+		r.people.patch({name: "ryan"})
+		assert_equal :patch, t.requests[1][:method], "Should have performed a patch request"
+
+		# CREATE/POST
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.create({name: "ryan"})
+		assert_equal :post, t.requests.first[:method], "Should have performed a post request"
+		r.people.post({name: "ryan"})
+		assert_equal :post, t.requests[1][:method], "Should have performed a post request"
+
+		# REMOVE/DELETE
+		t = Stretchr::TestTransporter.new
+		c = Stretchr::Client.new({project: "project", api_version: "v1.1", transporter: t})
+		r = Stretchr::Request.new({client: c})
+		r.people.remove
+		assert_equal :delete, t.requests.first[:method], "Should have performed a delete request"
+		r.people.delete
+		assert_equal :delete, t.requests[1][:method], "Should have performed a delete request"
+	end
+end

data/test/test_response.rb

@@ -0,0 +1,52 @@
+require "test_helper"
+
+describe "Response" do
+	it "Should take in and store a response" do
+		d = {name: "ryon"}.to_json
+		r = Stretchr::Response.new(d)
+		assert_equal d, r.raw, "Should have saved the raw response"
+	end
+
+	it "Should know if the response was successfull" do
+		r = Stretchr::Response.new(load_api_response("get_collection_response.json"))
+		assert r.success?, "Should have registered response as success"
+	end
+
+	it "Should parse out the json data" do
+		d = {name: "ryon"}.to_json
+		r = Stretchr::Response.new(d)
+		assert_equal "ryon", r.parsed["name"], "Should have parsed out the data"
+	end
+
+	it "Should no how to pull out data from a stretchr response" do
+		r = Stretchr::Response.new(load_api_response("get_single_response.json"))
+		assert_equal "value", r.data["field"], "Should have pulled actual data from stretchr standard response"
+	end
+
+	it "Should let me specify my own api_version" do
+		d = {name: "ryon"}.to_json
+		r = Stretchr::Response.new(d, {api_version: "v2"})
+		assert_equal "v2", r.api_version, "Should have let me specify the api version"
+	end
+
+	it "Should know how to extract errors out" do
+		r = Stretchr::Response.new(load_api_response("not_found_error.json"))
+		assert_equal false, r.success?, "Should have registered as a failure"
+		assert_equal "one", r.errors.first["~message"], "Should have returned the errors as an array"
+	end
+
+	it "Should be able to return the changes" do
+		r = Stretchr::Response.new(load_api_response("post_single_object.json"))
+		assert_equal 1, r.changes["~created"], "Should have returned the changes"
+	end
+
+	it "Should give me access to the status" do
+		r = Stretchr::Response.new(load_api_response("get_single_response.json"))
+		assert_equal 200, r.status, "Should have pulled out the response"
+	end
+
+	it "Should know how to pull items out of a response" do
+		r = Stretchr::Response.new(load_api_response("get_collection_response.json"))
+		assert_equal "Mat", r.items.first["name"], "Should know how to pull items from response"
+	end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.2.2
 platform: ruby
 authors:
 - Ryan Quinn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-30 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies: []
 description: A gem for interacting with your stretchr data
 email: ryan@mazondo.com
@@ -17,50 +16,45 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/stretchr/bag.rb
 - lib/stretchr/client.rb
-- lib/stretchr/configuration.rb
-- lib/stretchr/exceptions.rb
-- lib/stretchr/resources/resource.rb
-- lib/stretchr/resources.rb
-- lib/stretchr/security/signatory.rb
-- lib/stretchr/security.rb
-- lib/stretchr/stretchr_request.rb
-- lib/stretchr/stretchr_response.rb
-- lib/stretchr/transporters/default_transporter.rb
+- lib/stretchr/defaults.yaml
+- lib/stretchr/request.rb
+- lib/stretchr/response.rb
+- lib/stretchr/transporters/json_transporter.rb
 - lib/stretchr/transporters/test_transporter.rb
-- lib/stretchr/transporters.rb
 - lib/stretchr.rb
+- test/stubs/get_collection_response.json
+- test/stubs/get_single_response.json
+- test/stubs/not_found_error.json
+- test/stubs/post_single_object.json
+- test/test_bag.rb
 - test/test_client.rb
+- test/test_config.rb
 - test/test_helper.rb
-- test/test_resources.rb
-- test/test_signatory.rb
-- test/test_stretchr_http_actions.rb
-- test/test_stretchr_request.rb
-- test/test_stretchr_response.rb
-- test/test_test_transporter.rb
-homepage: http://www.stretchr.com
+- test/test_request.rb
+- test/test_response.rb
+homepage: https://github.com/stretchr/sdk-ruby
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A gem for managing your stretchr data
 test_files: []
-has_rdoc: 

data/lib/stretchr/configuration.rb

@@ -1,20 +0,0 @@
-module Stretchr
-
-	class Configuration
-
-		def self.add_option(name, default_value = nil)
-			attr_accessor name
-			@name = default_value		
-		end
-
-		add_option :private_key
-		add_option :public_key
-		add_option :project
-		add_option :noisy_errors
-
-		def method_missing(name, *params)
-			raise Stretchr::UnknownConfiguration
-		end
-	end
-
-end

data/lib/stretchr/exceptions.rb

@@ -1,18 +0,0 @@
-#FIXME : Right now we just define some errors that users can implement if they wish.  Should we implement them for them?
-module Stretchr
-	#basic stretchr error namespace
-	class StretchrError < StandardError; end
-
-	#Configuration
-	class MissingAttributeError < StretchrError; end #thrown when initializing client without params
-	class UnknownConfiguration < StretchrError; end #thrown when we try to set an unknown configuration option
-
-	#stretchr status errors
-	class NotFound < StretchrError; end
-	class InternalServerError < StretchrError; end
-	class BadRequest < StretchrError; end
-	class Unathorized < StretchrError; end
-	class Forbidden < StretchrError; end
-	class Unknown < StretchrError; end
-
-end