stretchr 1.0.0 → 1.2.2

data/lib/stretchr/resources/resource.rb

@@ -1,129 +0,0 @@
-module Stretchr
-	class Resource
-
-		# Class Methods to find objects
-
-		def self.find(params = {})
-			stretchr = stretchr_client
-			#FIXME : Why does this need to be duplicated?
-			stretchr.path = prep_path(stretchr.path.dup, params)
-			response = stretchr.get
-			return false if !response.success?
-			self.new(response.data)
-		end
-
-		def self.all(params = {})
-			stretchr = stretchr_client
-			stretchr.path = prep_path(stretchr.path.dup, params)
-			response = stretchr.get
-			return [] if response.data["~c"] == 0 || !response.data["~i"]
-			response.data["~i"].map {|r| self.new(r) }
-		end
-
-		def self.where(params = {})
-			stretchr = stretchr_client
-			#snag the vars that are needed for the path
-			path_vars = stretchr.path.scan(/:([a-zA-Z0-9_-]*)/i).flatten
-			#now convert the path as best we can
-			stretchr.path = prep_path(stretchr.path.dup, params)
-			#now remove the path params from the request
-			params.delete_if {|key, value| path_vars.include?(key.to_s)}
-
-			response = stretchr.where(params).get
-			#return false if nothing returned or search wasn't successful
-			return false if !response.success? || response.data["~c"] == 0 || !response.data["~i"]
-			response.data["~i"].map {|i| self.new(i) }
-		end
-
-		def self.stretchr_client
-			Stretchr::Client.new(@config)
-		end
-
-		def self.create(objects = [], params = {})
-			#convert it to an array for easy adding
-			objects = [objects] if !objects.is_a?(Array)
-			objects.map! {|o| setup_attributes_for_stretchr(o) }
-			stretchr = stretchr_client
-			stretchr.path = prep_path(stretchr.path.dup, params)
-			stretchr.body(objects)
-			response = stretchr.post
-			count = 0
-			stretchr_objects = objects.map do |o|
-				account = self.new(o)
-				account.parse_changes(response.changed[count])
-				count += 1
-				account
-			end
-			return stretchr_objects.first if stretchr_objects.length == 1
-			return stretchr_objects
-		end
-
-		def self.stretchr_config(params = {})
-			@config ||= {}
-			@config.merge!(params)
-		end
-
-		# Instance Methods
-
-		def initialize(params = {})
-			@attributes = {}
-			params.each {|key, value| self.send("#{key}=", value) }
-		end
-
-		def save(params = {})
-			stretchr = self.class.stretchr_client
-			stretchr.path = self.class.prep_path(stretchr.path.dup, params)
-			stretchr.body(setup_attributes_for_stretchr)
-			if self.stretchr_id
-				response = stretchr.put
-			else
-				response = stretchr.post
-			end
-			parse_changes(response.changed)
-		end
-
-		def parse_changes(response)
-			#FIXME : Should handle change objects and deltas here and update the object accordingly
-			return unless response
-			response.each {|key, value| self.send("#{key}=", value)}
-			self
-		end
-
-		def to_hash
-			@attributes
-		end
-
-		def to_json
-			to_hash.to_json
-		end
-	  
-		def method_missing(method, *args)
-			attribute = method.to_s
-			if attribute =~ /=$/ #if the method name ends in an =
-				@attributes[attribute.chop.gsub("~", "stretchr_")] = args[0]
-			else
-				@attributes[attribute]
-			end
-		end
-
-		private
-
-		def self.prep_path(path, params = {})
-			params.each {|key, value| path.gsub!(":#{key.to_s}", value.to_s) unless value == nil}
-			#remove any unchanged params from the path
-			path.gsub!(/(:[a-zA-Z0-9_-]*)/, "")
-			path
-		end
-
-		def setup_attributes_for_stretchr
-			self.class.setup_attributes_for_stretchr(@attributes)
-		end
-
-		def self.setup_attributes_for_stretchr(attributes)
-			stretchr_attributes = {}
-			attributes.each_pair {|key, value| stretchr_attributes[key.to_s.gsub(/^stretchr_/, "~")] = value}
-			stretchr_attributes
-		end
-
-	end
-end

data/lib/stretchr/resources.rb

@@ -1 +0,0 @@
-require_relative 'resources/resource.rb'

data/lib/stretchr/security/signatory.rb

@@ -1,52 +0,0 @@
-require 'uri' unless defined? URI
-require 'cgi' unless defined? CGI
-require 'digest/sha1'
-
-module Stretchr
-	class Signatory
-		class << self
-			def generate_signed_url(method, uri, public_key, private_key, body = nil)
-
-				#we need a URI, let's make sure it's what we have
-				uri = URI.parse(URI.escape(uri)) unless uri.is_a?(URI)
-
-				#preparation
-				query = CGI.parse(uri.query || "")
-				query["~key"] = public_key
-
-				#store this for later, we'll need it
-				public_query = URI.encode_www_form(query)
-
-				#now add the private stuff
-				query["~private"] = private_key
-				query["~bodyhash"] = Digest::SHA1.hexdigest(body) unless body == nil
-
-				#sort it
-				query = sort_query(query)
-				uri.query = URI.encode_www_form(query)
-
-				#append the method
-				signature = generate_signature(method, uri.to_s)
-
-				#now we prepare it for public use
-				public_query = public_query + "&" unless public_query == nil
-				uri.query = public_query + URI.encode_www_form("~sign" => signature)
-
-				return uri
-			end
-
-			private
-
-			def generate_signature(http_method, private_url)
-				combined = "#{http_method.to_s.upcase}&#{CGI.unescape(private_url.to_s)}"
-				Digest::SHA1.hexdigest(combined)
-			end
-
-			def sort_query(query)
-				query.each do |key, value|
-					value.sort! if value.is_a?(Array)
-				end.sort
-			end
-		end
-	end
-end

data/lib/stretchr/security.rb

@@ -1 +0,0 @@
-require_relative 'security/signatory'

data/lib/stretchr/stretchr_request.rb

@@ -1,16 +0,0 @@
-module Stretchr
-	class Request
-
-	  attr_accessor :http_method, :body, :signed_uri, :headers
-
-	  def initialize(options = {})
-
-	    @http_method = options[:http_method]
-	    @body = options[:body]
-	    @signed_uri = options[:signed_uri]
-	    @headers = options[:headers]
-
-	  end
-
-	end
-end

data/lib/stretchr/stretchr_response.rb

@@ -1,39 +0,0 @@
-require 'json' unless defined? JSON
-module Stretchr
-  class Response
-
-    attr_reader :json_string, :json_object, :status, :client_context, :data, :changed, :errors, :raw_response
-
-    def initialize(options = nil)
-
-      options ||= {}
-
-      @raw_response = options[:response]
-
-      if options[:json]
-        
-        # save the original json string
-        @json_string = options[:json]
-        @json_object = JSON.parse(@json_string)
-
-        @status = @json_object["~s"]
-
-        @client_context = @json_object["~x"]
-        @data = @json_object["~d"]
-        @changed = @json_object["~ch"]["~deltas"] if @json_object["~ch"]
-
-        unless @json_object["~e"].nil?
-          @errors = @json_object["~e"].collect {| error_obj | error_obj["~m"] }
-        end
-
-      end
-
-    end
-
-    # Gets whether this is a successful response.
-    def success?
-      @status >= 200 && @status <= 299
-    end
-
-  end
-end

data/lib/stretchr/transporters/default_transporter.rb

@@ -1,41 +0,0 @@
-require "uri" if !defined? URI
-require "net/http" if !defined? Net
-
-module Stretchr
-	class DefaultTransporter
-
-		def make_request(request)
-			response = nil
-			
-			Net::HTTP.start(request.signed_uri.host, request.signed_uri.port) do |http|
-
-			  http_request = generate_request(request)
-			  response = http.request http_request # Net::HTTPResponse object
-
-			end
-
-			return Stretchr::Response.new({:response => response, :json => response.body})
-		end
-
-		def generate_request(request)
-			
-			request_uri = request.signed_uri.request_uri
-
-			case request.http_method
-			when :get
-				req = Net::HTTP::Get.new request_uri
-			when :post
-				req = Net::HTTP::Post.new request_uri, {'Content-Type' => "application/json"}
-				req.body = request.body
-				req
-			when :put
-				req = Net::HTTP::Put.new request_uri, {'Content-Type' => "application/json"}
-				req.body = request.body
-				req
-			when :delete
-				req = Net::HTTP::Delete.new request_uri
-			end
-		end
-
-	end
-end

data/lib/stretchr/transporters.rb

@@ -1,2 +0,0 @@
-require_relative 'transporters/default_transporter.rb'
-require_relative 'transporters/test_transporter.rb'

data/test/test_resources.rb

@@ -1,187 +0,0 @@
-require 'test/unit'
-require 'test_helper.rb'
-
-class ResourcesTest < Test::Unit::TestCase
-	Stretchr.config do |s|
-		s.project = "test"
-		s.private_key = "test"
-		s.public_key = "test"
-	end
-
-	class Account < Stretchr::Resource
-		stretchr_config path: "/books/:id", transporter: Stretchr::TestTransporter.new
-
-		def self.load_response(response)
-			self.stretchr_client.transporter.responses << Stretchr::Response.new({json: response})
-		end
-	end
-
-	def test_ghost_methods
-		resource = Stretchr::Resource.new
-		resource.name = "Ryan"
-		assert_equal resource.name, "Ryan", "Should be able to create any attributes for a resource"
-	end
-
-	def test_resources_build_clients
-		assert_equal Stretchr::Resource.stretchr_client.class, Stretchr::Client, "Client should exist for Resources"
-		assert_equal Account.stretchr_client.path, "/books/:id"
-	end
-
-	def test_strip_tildes
-		account = Account.new({"~id" => "test"})
-		assert_equal "test", account.stretchr_id, "Should have stripped the tilde"
-	end
-
-	def test_can_find_resources
-		response = Stretchr::GenerateResponse.get_single_response({status: 200, data: {"~id" => "test", name: "Ryan"}})
-		Account.load_response(response)
-		account = Account.find({:id => "test"})
-		assert_equal Account, account.class, "Should have returned an account object"
-		assert_equal "Ryan", account.name, "Should have returned the data attributes as methods"
-	end
-
-	def test_can_get_all_resources
-		response = Stretchr::GenerateResponse.get_collection_response({objects: [{name: "Ryan", "~id" => "ryan"}, {name: "Tim", "~id" => "tim"}]})
-		Account.load_response(response)
-		accounts = Account.all
-		assert_equal "/books/", Account.stretchr_client.transporter.requests.last.signed_uri.path.gsub(/\/api\/v[0-9]*/, "") #gsub to trim out the /api/v1 bit
-		assert_equal accounts.first.class, Account, "Should have returned an array of account objects"
-		assert_equal accounts.first.name, "Ryan", "Should have returned the data for each object"
-	end
-
-	def test_single_from_all
-		response = Stretchr::GenerateResponse.get_collection_response({objects: [{name: "Ryan", "~id" => "ryan"}]})
-		Account.load_response(response)
-		accounts = Account.all
-		assert accounts.is_a?(Array), "Should return an array even for a single response"
-	end
-
-	def test_none_from_all
-		response = Stretchr::GenerateResponse.get_collection_response
-		Account.load_response(response)
-		accounts = Account.all
-		assert accounts.is_a?(Array), "Should return an array even for zero objects"
-	end
-
-	def test_save_new_object
-		account = Account.new
-		account.name = "Ryan"
-
-		response = Stretchr::GenerateResponse.post_response({deltas: {"~id" => "asdf"}})
-		Account.load_response(response)
-
-		account.save
-		assert_equal ({name: "Ryan"}).to_json, Account.stretchr_client.transporter.requests.last.body, "Should have set the correct body"
-		assert account.stretchr_id != nil, "Should have returned and set a stretchr id"
-	end
-
-	def test_save_new_object_with_id
-		account = Account.new
-		account.name = "Ryan"
-		account.stretchr_id = "ryan"
-
-		response = Stretchr::GenerateResponse.post_response
-		Account.load_response(response)
-
-		account.save
-		assert JSON.parse(Account.stretchr_client.transporter.requests.last.body).has_key?("~id"), "Should have set the stretchr id for me!"
-	end
-
-	def test_save_old_project
-		response = Stretchr::GenerateResponse.get_single_response({status: 200, data: {"~id" => "test", name: "Ryan"}})
-		Account.load_response(response)
-		account = Account.find({id: "test"})
-
-		account.name = "Ryan"
-
-		response = Stretchr::GenerateResponse.post_response
-		Account.load_response(response)
-		account.save
-
-		assert Account.stretchr_client.transporter.requests.last.http_method == :put, "Should have sent a put to update stretchr object"
-
-	end
-
-	def test_create_method
-		response = Stretchr::GenerateResponse.post_response({deltas: [{"~id" => "asdf"}]})
-		Account.load_response(response)
-
-		account = Account.create({name: "Ryan"})
-		assert_equal "Ryan", account.name, "Should have created the object with the attributes"
-		assert_equal "asdf", account.stretchr_id, "Should have given it a stretchr ID from the response"
-
-		response = Stretchr::GenerateResponse.post_response({deltas: [{"~id" => "ryan"}, {"~id" => "tim"}]})
-		Account.load_response(response)
-
-		accounts = Account.create([{name: "Ryan"}, {name: "Tim"}])
-		assert_equal "ryan", accounts.first.stretchr_id, "Should have returned an array of objects"
-		assert_equal "tim", accounts[1].stretchr_id, "Second object should work!"
-	end
-
-	def test_create_with_id
-		response = Stretchr::GenerateResponse.post_response({deltas: [{"~id" => "asdf"}]})
-		Account.load_response(response)
-
-		account = Account.create({name: "Ryan", stretchr_id: "ryan-id"})
-
-		assert Account.stretchr_client.transporter.requests.last.body.include?("~id"), "Should have set the ~id for stretchr"
-	end
-
-	def test_not_found
-		response = Stretchr::GenerateResponse.get_single_response({status: 404})
-		Account.load_response(response)
-		account = Account.find({id: "ryan"})
-		assert_equal false, account, "Should have returned false if object not found"
-	end
-
-	def test_find_resources
-		response = Stretchr::GenerateResponse.get_collection_response({objects: [{name: "Ryan", "~id" => "ryan"}, {name: "Ryan", "~id" => "tim"}]})
-		Account.load_response(response)
-		accounts = Account.where("name" => "Ryan")
-		assert accounts.length == 2, "should have returned two objects"
-		assert accounts.first.is_a?(Account), "should have returned an array of account objects"
-		assert accounts.first.name == "Ryan", "should have returned editable objects"
-	end
-
-	def test_find_no_resources
-		response = Stretchr::GenerateResponse.get_collection_response
-		Account.load_response(response)
-		accounts = Account.where("name" => "Ryan")
-		assert_equal false, accounts, "Should have returned false for no objects!"
-	end
-
-	def test_remove_params_from_path
-		response = Stretchr::GenerateResponse.get_collection_response({objects: [], in_response: 0})
-		Account.load_response(response)
-		accounts = Account.where({id: "test"})
-		last_uri = Account.stretchr_client.transporter.requests.last.signed_uri
-		assert last_uri.path.include?("/books/test"), "Should have set the path"
-		assert !URI.decode(last_uri.query).include?(":id"), "Should not have included id search in query"
-	end
-
-	def test_nil_path_param
-		assert_nothing_raised "Nil attributes shouldn't raise error" do
-			Stretchr::Resource.instance_eval { prep_path("/accounts/:account_id", {account_id: nil}) }
-		end
-	end
-
-	def test_number_for_param
-		assert_nothing_raised "Nil attributes shouldn't raise error" do
-			Stretchr::Resource.instance_eval { prep_path("/accounts/:account_id", {account_id: 123}) }
-		end
-	end
-
-	def test_to_json
-		account = Account.new
-		account.name = "Ryan"
-		account.stretchr_id = "asdf"
-		hash = {"name" => "Ryan", "stretchr_id" => "asdf"}
-		assert_equal hash, account.to_hash, "Should have returned a hash"
-		assert_equal hash.to_json, account.to_json, "Should have returned json"
-	end
-
-	#FIXME : It needs to know when an item already exists and when it's being created for the first time and handle them appropriately
-	#FIXME : It needs to be able to throw errors for 404, etc...
-	#FIXME : Should test "where" with params in the path as well.  It should add them to the path but remove them from the query
-
-end

data/test/test_signatory.rb

@@ -1,67 +0,0 @@
-require 'test/unit'
-require 'test_helper.rb'
-
-class ResourcesTest < Test::Unit::TestCase
-
-	def test_signed_uri
-
-		stretchr = test_stretchr_object
-		stretchr.people(123).books
-
-		assert_equal(true, stretchr.signed_uri.validate_param_presence("~sign"), "~sign param expected")
-
-	end
-
-	def test_signing
-		public_key = "ABC123"
-		private_key = "ABC123-private"
-		body = "body"
-		url = "http://test.stretchr.com/api/v1?:name=!Mat&:name=!Laurie&:age=>20"
-
-		#as per documentation
-		assert_equal true, Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key, body).validate_param_value("~sign", "6c3dc03b3f85c9eb80ed9e4bd21e82f1bbda5b8d"), "URL signature didn't match expected"
-	end
-
-	def test_signing_again
-		public_key = "ABC123"
-		private_key = "PRIVATE"
-		url = "http://localhost:8080/api/v1?:name=!Mat&:name=!Laurie&:age=>20"
-
-		#as per documentation
-		assert_equal "6841830bf612b03864edeebf9b99b7f48a8edf2d", Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key).get_param("~sign").first, "URL signature didn't match expected"
-
-	end
-
-	def test_signing_with_no_query
-		public_key = "ABC123"
-		private_key = "ABC123-private"
-		body = "body"
-		url = "http://test.stretchr.com/api/v1"
-
-		#as per documentation
-		assert_equal "d5e1dcbba794be7dc6767076bd4747b51837f21d", Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key, body).get_param("~sign").first, "URL signature didn't match expected"
-	end
-
-	def test_signing_with_escapable_characters
-
-		public_key = "ABC123"
-		private_key = "PRIVATE"
-		url = "http://localhost:8080/api/v1/people?:~created=>10000000"
-
-		#as per documentation
-		assert_equal "b54b16d3542a1497bf22c4f61aa935e81032e7b5", Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key).get_param("~sign").first, "URL signature didn't match expected"
-
-	end
-
-	def test_private_key_and_body_hash_removal
-		#we shouldn't see the private key or body hash in the final url
-		public_key = "ABC123"
-		private_key = "ABC123-private"
-		body = "body"
-		url = "http://test.stretchr.com/api/v1?:name=!Mat&:name=!Laurie&:age=>20"
-
-		assert_equal false, Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key, body).validate_param_presence("~private"), "private param included"
-		assert_equal false, Stretchr::Signatory.generate_signed_url("get", url, public_key, private_key, body).validate_param_presence("~bodyhash"), "private param included"
-	end
-
-end