sorry-api-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42f99a51702d04ea9c92deb01ff4bb76b8cdb2bb
+  data.tar.gz: 04c59b4eb2b861a1e3d327780578af19a4452c43
+SHA512:
+  metadata.gz: 173446fa96a09a9f6a6e67d3b4b351ed4cc4521c81ef4ec30008b50c371a7e915fa2245567118847ab36a8bd3996cf8964f0981c4f03a05fcaebe96f1417cfb7
+  data.tar.gz: a3727778b9850426eeecccb897a8295b1bcdb3dcaa7dbe9a151c1ef58b00be2bd464fb82f3b33ec410662902060a10384092806fbf8275bb49e16dc0981d6d9a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sorry-api-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 SORRYAPP LTD
+
+MIT License
+
+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,85 @@
+# Sorry™ API - Ruby
+
+> An easy to use Ruby wrapper for the [Sorry™](http://www.sorryapp.com) Status Page API. For details on what you can do with the API please check our [API Documentation](https://docs.sorryapp.com/api/v1/).
+
+## Installation
+
+To install the gem into the application you need to add it to your Gemfile.
+
+```ruby
+gem "sorry-api-ruby"
+```
+
+Once this has been done you can run `bundle install` to install the gem into your bundle.
+
+## Configuration
+
+Once the gem is installed you're ready to get up and running with it.
+
+```ruby
+client = Sorry::Api::Client.new('put your access token in here')
+```
+
+You can also instantiate the client without an access token, and it'll look for an ENV variable called 'SORRY_ACCESS_TOKEN' which is the preferable more-secure option if you're only ever connecting to a single Sorry™ account.
+
+## Usage
+
+Now you have your client you can begin to make requests to the API. This is done my chaining methods to match the path defined in the [Documentation](https://docs.sorryapp.com/api/v1/), and then terminate the call by the method you wish to perform i.e. *get(), create(), update() or delete().*
+
+##### GET
+
+```ruby
+client.pages.get # => Lists all the pages in the account.
+client.pages('kjh324jh').get # => Returns a single page with the given ID.
+client.pages('kjh324jh').brand.get # => Returns the pages brand settings.
+```
+
+##### POST/PUT
+
+```ruby
+client.pages.create(:name => 'My New Status Page') # => Creates a new page.
+client.pages('kjh324jh').update(:name => 'My Pages New Name') # => Updates the name of the page.
+```
+
+##### DELETE
+
+```ruby
+client.pages('kjh324jh').delete # => Deletes the page with the given ID.
+```
+
+## Contributing
+
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
+
+Once you are happy that your contribution is ready for production please send us a pull request, at which point we'll review the code and merge it in.
+
+## Versioning
+
+For transparency and insight into our release cycle, and for striving to maintain backward compatibility, This project will be maintained under the Semantic Versioning guidelines as much as possible.
+
+Releases will be numbered with the following format:
+
+`<major>.<minor>.<patch>`
+
+And constructed with the following guidelines:
+
+* Breaking backward compatibility bumps the major (and resets the minor and patch)
+* New additions without breaking backward compatibility bumps the minor (and resets the patch)
+* Bug fixes and misc changes bumps the patch
+
+For more information on SemVer, please visit <http://semver.org/>.
+
+## Authors & Contributors
+
+**Robert Rawlins**
+
++ <http://twitter.com/sirrawlins>
++ <https://github.com/SirRawlins>
+
+**Robin Geall**
+
++ <http://twitter.com/robingeall>
+
+## Copyright
+
+&copy; Copyright 2016 - See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sorry/api.rb

@@ -0,0 +1,16 @@
+# Import external 3rd party gems.
+# TODO: Add included 3rd party gems here.
+require "faraday"
+require "multi_json"
+
+# Import classes and modules for this gem.
+require "sorry/api/version"
+require "sorry/api/endpoint"
+require "sorry/api/client"
+require "sorry/api/request"
+
+# Define the core module.
+module Sorry
+  module Api
+  end
+end

data/lib/sorry/api/client.rb

@@ -0,0 +1,74 @@
+module Sorry
+	module Api
+	  	# The core API Client class, instantiated using
+	  	# the access token from your account. All requests stem from
+	  	# here.
+	  	class Client
+
+		  	# Attributes.
+		  	attr_accessor :access_token
+
+			# Initialize the API client.
+			def initialize(access_token: nil)
+				# Define the API Key, fallback to class config and/or environment variables.
+				@access_token = access_token || ENV['SORRY_ACCESS_TOKEN']
+
+				# TODO: Validate that it was able to intialize with an API key.
+
+				# Create an empty array to store the path
+				# parts for the recursive request building.
+				@path_parts = []
+			end
+
+			# Define the CRUD based methods.
+			%w(get post put delete).each do |name|
+				# Define the method based on it's name.
+				define_method "#{name}" do |**args|
+					# Nest in begin block for ensure to work.
+					begin
+						# Make the request to the API.
+						Sorry::Api::Request.new(builder: self).send("#{name}", **args)
+					ensure
+						# Reset the path once the request has
+						# been completed ready to have a new one
+						# placed together.
+						reset_path
+					end
+				end
+			end
+
+			# Path compilation.
+			#
+			# We use a method chaining on the missing method to build
+			# path. so pages().notices().updates() compiles to a string path
+			# of /pages/notice/updates which is then used to request the
+			# data back from the API.
+
+			# Get the entire path.
+			def path
+				# Combine the parts into a single string.
+				@path_parts.join('/')
+			end
+
+			# Use the missing methods to build
+			# the path using the method name as the
+			# part in the request path.
+		    def method_missing(method, *args)
+				# To support underscores, we replace them with hyphens when calling the API
+				@path_parts << method.to_s.gsub("_", "-").downcase
+				# Append any arguments to the path.
+				@path_parts << args if args.length > 0
+				# Flatter the parts to remove any duplcuates.
+				@path_parts.flatten!
+				# Return an instance of self
+				# so we can chain methods together.
+				self
+		    end
+
+		    # Reset the path parts once a CRUD
+		    # method has been called.
+		    def reset_path; @path_parts = []; end
+
+	  	end
+	end
+end

data/lib/sorry/api/endpoint.rb

@@ -0,0 +1,7 @@
+module Sorry
+  module Api
+  	# Define the URL endpoint for the api as a constant.
+  	# TODO: Make this programatic in time?
+  	ENDPOINT = "https://api.sorryapp.com/v1/"
+  end
+end

data/lib/sorry/api/request.rb

@@ -0,0 +1,82 @@
+module Sorry
+	module Api
+		# The core requests library, I actually  build and 
+		# make the HTTP requests to the API, parse responses etc.
+		class Request
+
+	    	# Initialze the request class.
+	  		def initialize(builder)
+	  			# Include the build class which
+	  			# will give us access to the path.
+	  			# TODO: Should we instantiate with this? or make this class methods?
+	  			@request_builder = builder
+	  		end
+
+			# Define the CRUD based methods.
+			%w(get post put delete).each do |name|
+				# Define the method based on it's name.
+				define_method "#{name}" do |**args|
+					# Try making the request.
+					begin
+						# Make the request through the REST client.
+						response = http_client.send("#{name}") do |request|
+							# Build the request with the parameters.
+							configure_request(request: request, params: args)
+						end
+
+						# Pasrse the response from the request.
+						parse_response(response.body)
+					# Handle any errors which occurr.
+					rescue => e
+						# Pass the request off to the error handler.
+						handle_error(e)
+					end
+				end
+			end
+
+	    	# Build the request from the
+	    	# givden parameters.
+			def configure_request(request: nil, params: nil)
+				# Set the URL of the request from the compiled path.
+				request.url @request_builder.path
+				# Marge the parameters into the request.
+				request.params.merge!(params) if params
+				# Set the request type to JSON.
+				request.headers['Content-Type'] = 'application/json'
+				# Include the bearer header if one applied as token.
+				request.headers['Content-Type']
+	  		end
+
+			# Handle/Parse an errors which happen.
+			def handle_error(error)
+				# Reraise the error for now.
+				# TODO: Handler proper errors somehow.
+				raise error
+			end
+
+			# Parse the reponse.
+			def parse_response(response_body)
+				# Parse the response body from JSON into Hash.
+				# Return the enveloped 'response' element.
+				MultiJson.load(response_body, :symbolize_keys => true)[:response]
+			end
+
+	  		# Get access to the HTTP client to make the request.
+	  		def http_client
+				# Configure Faraday as our HTTP client.
+				Faraday.new(Sorry::Api::ENDPOINT) do |faraday|
+					# Configure the adapter to throw erros
+					# based on the HTTP response codes.
+					faraday.response :raise_error
+					# Log to the command ling.
+					faraday.response :logger
+					# make requests with Net::HTTP
+					faraday.adapter Faraday.default_adapter
+					# Set the HTTP oAuth headers.
+					faraday.authorization :bearer, @request_builder.access_token if @request_builder.access_token
+				end
+	  		end
+
+		end
+	end
+end

data/lib/sorry/api/version.rb

@@ -0,0 +1,5 @@
+module Sorry
+  module Api
+  	VERSION = "0.0.1"
+  end
+end

data/sorry-api-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sorry/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sorry-api-ruby"
+  spec.version       = Sorry::Api::VERSION
+  spec.authors       = ["Robert Rawlins"]
+  spec.email         = ["robert@sorryapp.com"]
+  spec.summary       = "A Ruby gem for communicating with the Sorry™ API "
+  spec.description   = "An easy to use Ruby wrapper for the Sorry™ Status Page API. For details on what you can do with the API please check our API Documentation."
+  spec.homepage      = "https://docs.sorryapp.com/api/v1/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '>= 0.9.1'
+  spec.add_dependency 'multi_json', '>= 1.11.0'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "3.2.0"
+  spec.add_development_dependency 'webmock', "~> 1.21.0"
+  spec.add_development_dependency 'faker'
+end

data/spec/sorry/api/client_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Sorry::Api::Client do
+
+	# Placeholder access token.
+	let(:access_token) { Faker::Internet.password(128) }
+
+	describe 'attributes' do
+
+		it 'has no access token by default' do
+			# Instantiate the class.
+			client = Sorry::Api::Client.new
+			# Expect the client to have no access token.
+			expect(client.access_token).to be_nil
+		end
+
+		it 'sets the access token on instantiation' do
+			# Instantiate the class.
+			client = Sorry::Api::Client.new(access_token: access_token)
+			# Expect the client to have no access token.
+			expect(client.access_token).to eq(access_token)
+		end
+
+		it 'sets an API key from the SORRY_ACCESS_TOKEN ENV variable' do
+			# Set the placeholder ENV variable.
+			ENV['SORRY_ACCESS_TOKEN'] = access_token
+			# Instantiate the class.
+			client = Sorry::Api::Client.new
+			# Check that the correct token was set.
+			expect(client.access_token).to eq(access_token)
+		end
+
+		it 'sets the API key from the setter' do
+			# Instantiate the class.
+			client = Sorry::Api::Client.new
+			# Set the access token manually.
+			client.access_token = access_token
+			# Assert that the token is corrcetly set.
+			expect(client.access_token).to eq(access_token)
+		end
+
+	end
+
+	describe 'building the path' do
+
+		# Provide a skeleton client.
+		let(:client) { Sorry::Api::Client.new }
+		let(:method) { Faker::Lorem.word }
+
+		# Mock the path parts into the class.
+		before(:each) { client.instance_variable_set(:@path_parts, ['mock', 'path', 'parts']) }
+
+		it 'can reset the path' do			
+			# Reset the path parts.
+			client.reset_path
+			# Expect the path parts to be empty array.
+			expect(client.instance_variable_get(:@path_parts)).to be_empty
+		end
+
+		it 'can generate a url styled path' do
+			# Expect a nice slash delimited path.
+			expect(client.path).to eq('mock/path/parts')
+		end
+
+		it 'adds missing methods to the path' do
+			# Empty the path parts before testing.
+			client.instance_variable_set(:@path_parts, [])
+			# Make a request with a radnom method name.
+			client.send(method)
+			# Check to see if the path parts now contains
+			# the name of the method we invoked.
+			expect(client.instance_variable_get(:@path_parts)).to include(method)
+		end
+
+		it 'returns an instance of itself for chaining' do
+			# Make a request with a radnom method name.
+			client.send(method).to be(client)
+		end
+
+	end
+
+end

data/spec/sorry/api/request_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Sorry::Api::Request do
+
+	# Placeholder access token.
+	let(:access_token) { Faker::Internet.password(128) }
+
+	# Mock the request object.
+	let(:request) { Sorry::Api::Request.new(Sorry::Api::Client.new(access_token: access_token)) }
+
+	describe 'error handling' do
+
+		it 'should reraise any errors' do
+			# Pass the error handler a new instance of error.
+			expect{request.handle_error(StandardError.new)}.to raise_exception(StandardError)
+		end
+
+	end
+
+	describe 'response parsing' do
+
+		# Mock the response body to test the parses.
+		let(:response_body) { '{"response":{"id": 1, "name": "Some name"}}' }
+
+		it 'should return an response outside of its envelope' do
+			# Expect the parses to remove the envelop.
+			expect(request.parse_response(response_body)).to eq({:id => 1, :name => "Some name"})
+		end
+
+	end
+
+	describe 'the HTTP client' do
+
+		it 'should be a Faraday client' do
+			# Ask the instance for the http_client
+			expect(request.http_client).to be_a(Faraday::Connection)
+		end
+
+		it 'should be configured with the URL for the endpoint' do
+			# Ask the instance for the http_client
+			expect(request.http_client.url_prefix.to_s).to eq(Sorry::Api::ENDPOINT)
+		end
+
+		it 'has the access_token as a bearer header' do
+			# Ask the instance for the http_client
+			expect(request.http_client.headers).to include({"Authorization"=>"bearer #{access_token}"})
+		end
+
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+# Require the libs for testing.
+require 'sorry/api'
+# Faker lib for placeholder data.
+require 'faker'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sorry-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Rawlins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  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'
+description: An easy to use Ruby wrapper for the Sorry™ Status Page API. For details
+  on what you can do with the API please check our API Documentation.
+email:
+- robert@sorryapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sorry/.DS_Store
+- lib/sorry/api.rb
+- lib/sorry/api/.DS_Store
+- lib/sorry/api/client.rb
+- lib/sorry/api/endpoint.rb
+- lib/sorry/api/request.rb
+- lib/sorry/api/version.rb
+- sorry-api-ruby.gemspec
+- spec/sorry/api/client_spec.rb
+- spec/sorry/api/request_spec.rb
+- spec/spec_helper.rb
+homepage: https://docs.sorryapp.com/api/v1/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for communicating with the Sorry™ API
+test_files:
+- spec/sorry/api/client_spec.rb
+- spec/sorry/api/request_spec.rb
+- spec/spec_helper.rb