stretchr 1.0.0 → 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eba1f84e305e4aa0140195449c53abe1513d309b
+  data.tar.gz: 5bb66d1eefbf3cace2b220c70871d255fa38955e
+SHA512:
+  metadata.gz: 6b755e5410cb25f0781521be2590484768b81157c74acef767e5bd9abd5b4331c651dff28233cc30dca97ec3e4f37f7b19f0a754368e7f95732315cb24a666bd
+  data.tar.gz: 54e43e6a35302103c18cbc5c6181db05d613f2a43d7383512cbf279985d5bfcdb5d07df8b4f6771f4da0149b11b2aee113e8701da30db5529c1c9895de1df8d8

data/lib/stretchr/bag.rb

@@ -0,0 +1,52 @@
+require "uri"
+
+module Stretchr
+	# Bag is a general parameter holder with
+	# special functions for converting a hash into
+	# a query string for Stretchr
+	class Bag
+		def initialize(options = {})
+			@params = {} # the general param hash
+			@prefix = options[:prefix] # the prefix added to every key before saving
+		end
+
+		# Set will store a value for a given key
+		# ==== Parameters
+		# +param+ - The key to store the value under
+		# +value+ - The value to store under that key, will always overwrite, so send an array for multiples
+		#
+		# ==== Examples
+		# s = Stretchr::Bag.new
+		# s.set("key", "value")
+		# s.get("key") #=> "value"
+		def set(param, value)
+			param = "#{@prefix}#{param}" if @prefix
+			@params[param] = value
+		end
+
+		# Get will retrieve a stored value
+		# ==== Parameters
+		# +param+ - The key to retrieve the values for
+		#
+		# ==== Examples
+		# s = Stretchr::Bag.new
+		# s.set("key", "value")
+		# s.get("key") #=> "value"
+		def get(param)
+			param = "#{@prefix}#{param}" if @prefix
+			@params[param]
+		end
+
+		# Returns a url encoded query string of the current stored
+		# values
+		#
+		# ==== Examples
+		# s = Stretchr::Bag.new
+		# s.set("key", "value")
+		# s.set("key2", ["value1", "value2"])
+		# s.query_string #=> "key=value&key2=value1&key2=value2"
+		def query_string
+			URI.encode_www_form(@params)
+		end
+	end
+end

data/lib/stretchr/client.rb

@@ -1,201 +1,34 @@
 module Stretchr
-
 	class Client
+		attr_accessor :transporter, :api_version, :project, :key, :hostname
+		# Initializes a new stretchr client
+		# This is the main entrypoint into working with stretchr
+		#
+		# ==== Parameters
+		# +options[:project]+ - The project you're working with
+		# +options[:key]+ - The key for the project you want to use
+		# +options[:transporter]+ - The transporter to use for actually making requests
+		# +options[:api_version]+ - The stretchr API endpoint we want to communicate with
 		def initialize(options = {})
-			options ||= {}
-		
-			options[:project] ||= Stretchr.configuration.project
-			options[:private_key] ||= Stretchr.configuration.private_key
-			options[:public_key] ||= Stretchr.configuration.public_key
-			options[:noisy_errors] ||= (Stretchr.configuration.noisy_errors || false)
-			# check for required arguments
-			[:project, :public_key, :private_key].each do | required_option |
-				raise MissingAttributeError, "#{required_option} is required." unless options[required_option]
-			end
-
-			options.each do |name, value|
-					send("#{name}=", value)
-			end
-
-			# create defaults if the user didn't specify anything
-			@signatory ||= Stretchr::Signatory
-			@transporter ||= Stretchr::DefaultTransporter.new
-			@version ||= "v1"
-			@path ||= ""
-			@query = {}
-
-		end
-
-		attr_accessor :project, :private_key, :public_key, :path, :http_method, :http_body, :version, :transporter, :signatory, :noisy_errors
-
-		#-------------------HTTP Actions-----------------
-
-		# generate_request makes a Stretchr::Request based on the current settings
-		# in this Stretchr object.
-		def generate_request
-			Stretchr::Request.new(
-				:http_method => http_method,
-				:signed_uri => signed_uri,
-				:body => http_body
-			)
-		end
-
-		def make_request!
-			# create and make the request
-			response = self.transporter.make_request(generate_request)
-			raise_errors_in_response(response) if noisy_errors
-			response
-		end
-
-	    def raise_errors_in_response(response)
-	        if [404, 500, 401, 403, 406, 400].include?(response.status)
-	          raise_error(response.status)
-	        end 
-	    end
-
-	    def raise_error(status)
-	      case status
-	      when 404 
-	        raise NotFound
-	      when 500 
-	        raise InternalServerError
-	      when 401 
-	        raise Unauthorized
-	      when 403 
-	        raise Forbidden
-	      when 400 
-	        raise BadRequest
-	      else
-	        raise Unknown
-	      end    
-	    end
-
-		# get performs a GET request and returns the Stretchr::Response.
-		def get
-
-			self.http_method = :get
-			make_request!
-
-		end
-
-		# post performs a POST and returns a Stretch::Response
-		def post
-			self.http_method = :post
-			make_request!
-		end
-
-		def put
-			self.http_method = :put
-			make_request!
-		end
-
-		def delete
-			self.http_method = :delete
-			make_request!
-		end
-
-	    #---------------- Friendly Actions --------------
-
-	    def create(object)
-	      self.body(object).post
-	    end
-
-	    def replace(object)
-	      self.body(object).post
-	    end
-
-	    def update(object)
-	      self.body(object).put
-	    end
-
-	    def read
-	      self.get
-	    end
-
-		#----------------Friendly Functions--------------
-		def url
-			uri.to_s
-		end
-
-		def to_url
-			url
-		end
-
-		def uri
-			URI::HTTP.build(host: "#{project}.stretchr.com", query: merge_query, path: merge_path)
-		end
-
-		def signed_uri
-			Stretchr::Signatory.generate_signed_url(http_method, uri, public_key, private_key, http_body)
-		end
-
-		#---------------Parameter Building---------------
-
-		def order(parameters)
-			@query["~order"] = parameters.to_s
-			self
-		end
-
-		def skip(parameters)
-			@query["~skip"] = parameters.to_i
-			self
-		end
-
-		def limit(parameters)
-			@query["~limit"] = parameters.to_i
-			self
-		end
-
-		def page(parameters)
-			skip((@query["~limit"] * parameters.to_i) - @query["~limit"])
-			self
-		end
-
-		def parameters(parameters)
-			@query.merge!(parameters)
-			self
-		end
-
-		def body(body_params)
-			self.http_body = body_params.to_json
-
-			self
-		end
-
-		def where(params)
-			params.each do |key, value|
-				@query["\:#{key.to_s}"] = value
-			end
-			self
-		end
-
-		#-----------------Basic Routing-----------------
-
+			self.transporter = options[:transporter] || Stretchr::JSONTransporter.new
+			self.api_version = options[:api_version] || Stretchr.config["api_version"]
+			self.project = options[:project]
+			self.key = options[:key]
+			self.hostname = options[:hostname] || Stretchr.config["hostname"]
+		end
+
+		# Catches everything you can throw at client and passes it on to a new request object
+		# All interactions will then take place on the request object itself
+		# This is the primary function of the Client class, to get you into 
+		# a unique request as quickly as possible
+		#
+		# ==== Example
+		# stretchr = Stretchr::Client.new({project: "project", key: "key"})
+		# stretchr.people(1).cars.path # => people/1/cars
 		def method_missing(method, *args)
-			add_collection(method, *args)
-		end
-
-		def add_collection(collection, id = nil)
-			@path += "/#{collection}"
-			if id
-				id.gsub!(/[^0-9A-Za-z.\-]/, '_') if id.is_a?(String) #remove non-ascii
-				@path += "/#{id}"
-			end
-			self
+			r = Stretchr::Request.new({client: self})
+			r.param("key", key) if key
+			r.send(method, *args)
 		end
-
-		private
-
-		def merge_query
-			unless @query == nil || @query == {}
-				URI.encode_www_form(@query)
-			end
-		end
-
-		def merge_path
-			"/api/#{version}" + @path
-		end
-
 	end
-
 end

data/lib/stretchr/defaults.yaml

@@ -0,0 +1,8 @@
+api_version: v1.1
+hostname: stretchr.com
+v1.1:
+  status: ~status
+  data: ~data
+  errors: ~errors
+  changes: ~changes
+  items: ~items

data/lib/stretchr/request.rb

@@ -0,0 +1,194 @@
+require "uri"
+
+module Stretchr
+	# The request class is where most of the url building magic takes place
+	# It collects all methods passed to it and uses them to build a url for you
+	class Request
+		attr_accessor :client
+		def initialize(options = {})
+			# Pass in the client so we get all the options required
+			self.client = options[:client]
+
+			# URL BUILDING
+			# This is where we'll initialize everything needed to build up the urls
+			@path_elements = []
+			@params = Stretchr::Bag.new # a bag to hold the params for th url building
+			@filters = Stretchr::Bag.new({prefix: ":"}) # a bag to hold the filters
+		end
+
+		# Returns the current path that the request is working with
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people(1).cars.path #=> "people/1/cars"
+		def path
+			@path_elements.join("/")
+		end
+
+		# Returns the full url, including the path for the current request
+		def to_url
+			to_uri.to_s
+		end
+
+		# Builds a URI object
+		def to_uri
+			URI::HTTP.build(host: merge_host, path: merge_path, query: merge_query)
+		end
+
+		# Set params for the url
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.param("key", "value")
+		def param(key, value)
+			@params.set(key, value)
+			return self
+		end
+
+		# Set filters for the url
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.where("key", "value")
+		def where(key, value)
+			@filters.set(key, value)
+			return self
+		end
+
+		# Sets the maximum number of items you want to get back
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.accounts.limit(10).get #=> Returns 10 accounts
+		def limit(value)
+			param("limit", value)
+		end
+
+		# Tell stretchr to skip some items in the response
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.accounts.limit(10).skip(10).get #=> Returns 10 accounts, starting at 11
+		def skip(value)
+			param("skip", value)
+		end
+
+		# Convenience method for using pages instead of skip values
+		# defaults to 1000 if no limit is known yet
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.accounts.limit(10).page(2).get #=> Returns 10 accounts, starting at 11
+		def page(value)
+			l = @params.get("limit") || 1000
+			skip((l.to_i * value.to_i) - l.to_i)
+		end
+
+		# Set the order of the response
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.accounts.order("-name").get #=> Orders accounts by name, descending
+		def order(value)
+			param("order", value)
+		end
+
+		# Performs a GET for the current request
+		# Returns a Stretchr::Response object
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people.get #=> Stretchr::Response object
+		def get
+			self.make_request!({uri: self.to_uri, method: :get})
+		end
+		alias :read :get
+
+		# Performs a POST to create a new resource
+		# Returns a Stretchr::Response object
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people.create({name: "ryan"}) #=> Stretchr::Response object
+		def create(body)
+			self.make_request!({uri: self.to_uri, method: :post, body: body})
+		end
+		alias :post :create
+
+		# Performs a PUT to replace an object
+		# Returns a Stretchr::Response object
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people.replace({name: "ryan"}) #=> Stretchr::Response object
+		def replace(body)
+			self.make_request!({uri: self.to_uri, method: :put, body: body})
+		end
+		alias :put :replace
+
+		# Performs a PATCH to update an object
+		# will not delete non-included fields
+		# just update included ones
+		# Returns a Stretchr::Response object
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people.update({name: "ryan"}) #=> Stretchr::Response object
+		def update(body)
+			self.make_request!({uri: self.to_uri, method: :patch, body: body})
+		end
+		alias :patch :update
+
+		# Performs a DELETE to remove an object
+		# deletes an object or entire collection
+		# SERIOUSLY - THIS DELETES THINGS
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people.remove #=> Stretchr::Response object
+		def remove
+			self.make_request!({uri: self.to_uri, method: :delete})
+		end
+		alias :delete :remove
+
+		# Actually sends the request to the transporter
+		def make_request!(options = {})
+			options[:client] = client
+			self.client.transporter.make_request(options)
+		end
+
+
+		# Catch everyting not defined and turn it into url parameters
+		# If you include an argument, it will be passed into the url as the ID for the
+		# collection you specified in the method name
+		#
+		# ==== Examples
+		# r = Stretchr::Request.new
+		# r.people(1).cars.path #=> "people/1/cars"
+		def method_missing(method, *args)
+			@path_elements << method.to_s
+			@path_elements << args[0] if args[0]
+			return self
+		end
+
+		private
+
+		# Merges the path from the @path_elements
+		def merge_path
+			"/api/#{client.api_version}/#{@path_elements.join('/')}"
+		end
+
+		# Merges query params and filter params
+		def merge_query
+			p = []
+			p << @params.query_string unless @params.query_string == ""
+			p << @filters.query_string unless @filters.query_string == ""
+			return p.size > 0 ? p.join("&") : nil
+		end
+
+		# Generate the host from the hostname and project
+		def merge_host
+			"#{client.project}.#{client.hostname}"
+		end
+	end
+end

data/lib/stretchr/response.rb

@@ -0,0 +1,30 @@
+require "json"
+module Stretchr
+	# Response parser for stretchr
+	# ==== Parameters
+	# +response+ - The raw response from stretchr
+	# +options[:api_version]+ - The version of the api we're talking to, tells us how to parse
+	class Response
+		attr_reader :raw, :parsed, :data, :api_version, :errors, :changes, :status, :items
+		def initialize(response, options = {})
+			@api_version = options[:api_version] || Stretchr.config["api_version"] #api version is used to determine how to parse response
+			@raw = response
+			@parsed = JSON.parse(response)
+			begin
+				@data = @parsed[Stretchr.config[@api_version]["data"]] #stretchr data object
+				@errors = @parsed[Stretchr.config[@api_version]["errors"]] #errors
+				@changes = @parsed[Stretchr.config[@api_version]["changes"]] #changes (POST/PUT/PATCH/DELETE)
+				@status = @parsed[Stretchr.config[@api_version]["status"]] #request status
+				if @data
+					@items = @data[Stretchr.config[@api_version]["items"]]
+				end
+			rescue
+			end
+		end
+
+		# Returns whether or not the request was successful
+		def success?
+			@status >= 200 && @status <= 299
+		end
+	end
+end

data/lib/stretchr/transporters/json_transporter.rb

@@ -0,0 +1,47 @@
+require "uri" if !defined? URI
+require "net/http" if !defined? Net
+module Stretchr
+	class JSONTransporter
+		# Perform the request against stretchr
+		# ==== Parameters
+		# +request+ - The request object
+		# Expects: {uri: URIOBJECT, body: "body", method: "PUT/PATCH/POST/DELETE/GET", client: stretchr client}
+		def make_request(request)
+			response = nil
+			Net::HTTP.start(request[:uri].host, request[:uri].port) do |http|
+				http_request = generate_request(request)
+				response = http.request http_request # Net::HTTPResponse object
+			end
+			if request[:client]
+				return Stretchr::Response.new(response.body, {:api_version => request[:client].api_version})
+			else
+				return Stretchr::Response.new(response.body)
+			end
+		end
+
+		# Generates the actual request, including the method
+		def generate_request(request)
+
+			request_uri = request[:uri].request_uri
+
+			case request[: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 :patch
+				req = Net::HTTP::Patch.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/test_transporter.rb

@@ -1,25 +1,14 @@
 module Stretchr
-  class TestTransporter
-
-    attr_accessor :requests, :responses
-
-    def initialize
-      self.requests = []
-      self.responses = []
-    end
-   
-  	def make_request(request)
-  		
-  		# store the request and return the next response in the local queue
-  		# not NOT actually make any http requests
-
-      self.requests << request
-
-      # return the response
-      self.responses.shift
-
-  	end
-
-    
-  end
+	class TestTransporter
+		attr_accessor :requests, :responses
+		def initialize
+			self.requests = []
+			self.responses = []
+		end
+
+		def make_request(request)
+			requests << request
+			responses.shift
+		end
+	end
 end

data/lib/stretchr.rb

@@ -1,32 +1,31 @@
-require "uri"
-require "cgi"
-require "json"
-
-
+# Config File 
+# This file contains all the configuration for the stretchr api
+# and this gem.  They are namespaced by api version where appropriate
+require "yaml"
 module Stretchr
-	#exceptions that can be used by stretchr
-	require_relative 'stretchr/exceptions'
-
-	#configuration
-	require_relative 'stretchr/configuration'
+	def self.config
+		@config ||= YAML::load_file(File.join(Dir.pwd,"lib", "stretchr", "defaults.yaml"))
+	end
+end
 
-	@configuration = Stretchr::Configuration.new
+# The main stretchr client
+require "stretchr/client"
 
-	def self.configuration
-		@configuration
-	end
+# The main stretchr request, this is where the url is built
+require "stretchr/request"
 
-	def self.config
-		yield(@configuration)	
-	end
+# Bags are responsible for hanging on to params while building urls
+require "stretchr/bag"
 
-	#the actual client library
-	require_relative 'stretchr/client'
-	require_relative 'stretchr/security'
-	require_relative 'stretchr/transporters'
-	require_relative 'stretchr/resources'
-	require_relative 'stretchr/stretchr_request'
-	require_relative 'stretchr/stretchr_response'
+# Transporters
+# A transporter is anything that actually makes requests
+# It is a class with only one public function: make_request(request)
+# you pass in a request object, it performs the request and then
+# returns a response object
+require "stretchr/transporters/test_transporter" # a transporter for testing, does not make real requests
+require "stretchr/transporters/json_transporter" # a transporter that uses json to talk to stretchr
 
-	
-end
+# Response object
+# The response object takes in a JSON response from stretchr
+# and parses it into more easily used data
+require "stretchr/response"

data/test/stubs/get_collection_response.json

@@ -0,0 +1,13 @@
+{
+    "~data":{
+        "~count":4,
+        "~items":[
+            {"name":"Mat","~id":"id-here"},
+            {"name":"Laurie","~id":"id-here"},
+            {"name":"Steve","~id":"id-here"},
+            {"name":"Chi","~id":"id-here"}
+        ],
+        "~total": 155563
+    },
+    "~status":200
+}

data/test/stubs/get_single_response.json

@@ -0,0 +1,6 @@
+{
+    "~data":{
+        "field":"value"
+    },
+    "~status": 200
+}

data/test/stubs/not_found_error.json

@@ -0,0 +1,4 @@
+{
+    "~status": 404,
+    "~errors": [{"~message":"one"}, {"~message":"two"}]
+}