norseal-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47cbda0035f1a87d64ed4ecda1fec8a48433a833
-  data.tar.gz: fcfb623f29e03cd5775939e9e70a17e6c0b000f4
+  metadata.gz: aebba70883bbc95f842ad486aea00a8d17708fe0
+  data.tar.gz: c4bddf4b2416a2243f20b264c12418f114eee3ca
 SHA512:
-  metadata.gz: 665240d6320dc6ed310debac762b75fd4bfce528caa7a0dec74c16f06534025c874e9da943dd2ab07d821835c8c3ba97ea9438252166daecd96d3f220d5753f9
-  data.tar.gz: ed270c39414029fe520d25dc795177258d33ad7967182c816c8a5cdbb6bfe2154a48b6224e4720092f77a39c6d90ec27541dd7da931b84ea809438d849831e01
+  metadata.gz: ed238a3fa30fd3217da9621c9830819e9878e3a0006b30e012159ddabae9b4c881d175579d620ce0bc6ad8b05572283131cdd76a93a908b5cca7373aa0a6a077
+  data.tar.gz: 690b3f259c2d9425ab8aa81f7ba43ab09361165720aa4d57bb6a09b7f516f09c2e2ad48aad6956fd6829bed9adf16c536ca54266bc1a4cc5c3a5892dfaa009a3

data/.gitignore

@@ -7,9 +7,3 @@
 /pkg/
 /spec/reports/
 /tmp/
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2015 Jamie Barton
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2015 Jamie Barton
 
-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:
+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 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.
+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

@@ -1,6 +1,8 @@
 # Norseal::Api
 
-TODO: Write a gem description
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/norseal/api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,6 +24,12 @@ Or install it yourself as:
 
 TODO: Write usage instructions here
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/norseal-api/fork )

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "norseal/api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/norseal/api.rb

@@ -1,11 +1,33 @@
-# require "norseal/api/version"
+require 'her'
+require 'active_support/concern'
+require 'norseal/api/model'
 
 module Norseal
   module Api
-    class Product
-      def self.addition(num, num2)
-        num + num2
+    class ClientNotConfigured < Exception; end
+
+    def self.configure(host, api_key, &block)
+      @api = Her::API.new
+
+      @api.setup :url => "http://#{host}/" do |c|
+        # c.use FaradayMiddleware::EncodeJson
+        c.use Her::Middleware::AcceptJSON
+        c.use Her::Middleware::FirstLevelParseJSON
+
+        c.authorization :token, api_key
+
+        yield c if block_given?
+
+        c.adapter Faraday.default_adapter unless c.builder.handlers.include?(Faraday::Adapter::Test)
       end
+
+      require "norseal/api/resources/collection"
+      require "norseal/api/resources/product"
+    end
+
+    def self.api
+      raise ClientNotConfigured.new("Norseal") unless @api
+      @api
     end
   end
 end

data/lib/norseal/api/version.rb

@@ -1,5 +1,5 @@
 module Norseal
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/norseal-api.gemspec

@@ -8,16 +8,19 @@ Gem::Specification.new do |spec|
   spec.version       = Norseal::Api::VERSION
   spec.authors       = ["Jamie Barton"]
   spec.email         = ["jamie@codethisway.com"]
-  spec.summary       = %q{API middleware for Norseal.}
-  spec.description   = %q{Authenticate and talk with the Norseal database.}
-  spec.homepage      = ""
+
+  spec.summary       = %q{Consume the Norseal API.}
+  spec.description   = %q{This middleware uses Her & Faraday for consuming the Norseal Api}
+  spec.homepage      = "http://norseal.co.uk"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   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_development_dependency "bundler", "~> 1.7"
+  spec.add_dependency 'her'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: norseal-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jamie Barton
@@ -10,20 +10,62 @@ bindir: bin
 cert_chain: []
 date: 2015-02-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  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: activesupport
+  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: faraday_middleware
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,22 +80,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Authenticate and talk with the Norseal database.
+description: This middleware uses Her & Faraday for consuming the Norseal Api
 email:
 - jamie@codethisway.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - lib/norseal/api.rb
 - lib/norseal/api/version.rb
 - norseal-api.gemspec
-homepage: ''
+homepage: http://norseal.co.uk
 licenses:
 - MIT
 metadata: {}
@@ -76,5 +123,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: API middleware for Norseal.
+summary: Consume the Norseal API.
 test_files: []