northpasser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 754649575db1e0559e07c31846aa2ba37c3d344f
+  data.tar.gz: 77891153f6f48d64cc280900702e0053a77ec5f5
+SHA512:
+  metadata.gz: 02c6c3c051960bc718e94428fa5c7b04061f4bb9bbebf6b9718bfbaf27b5bbf9af4f981ef44e011cf1ff75d2f56ed80fccb68b11f238ecd37e4c43108a85a3ee
+  data.tar.gz: 023bcb04f722d1eee97e6a1fa7902a61ccf7e2b9b2f6cb55985cc054b5d81ece6735df99cf1f052d505dae9d8b378b43972eabf6b01df593321a61bfe2cdd896

data/.gitignore

@@ -0,0 +1 @@
+.env

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    northpass (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dotenv (2.2.1)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    vcr (3.0.3)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  dotenv (~> 2.1)
+  northpass!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  vcr (~> 3.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mark Hutter 
+
+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,209 @@
+# Northpasser
+
+Northpasser is a lightweight Ruby wrapper of the
+[Northpass API](https://app.northpass.com/api/v1/).
+
+[Northpass](https://northpass.com) is a radical project management tool
+particularly well suited to software development. If you're not familiar with
+them, go check them out! :heart:
+
+
+## Inspiration 
+This gem is heavily inspired by [Philip Castiglione](https://github.com/PhilipCastiglione)'s 
+Ruby [gem](https://github.com/PhilipCastiglione/clubhouse_ruby) for the Clubhouse API
+
+Philip's restated philosophy on these techniques:
+> ...A good API wrapper is a simpler alternative to a comprehensive client 
+> library and can provide a nice interface to the API using dynamic 
+> Ruby metaprogramming techniques rather than mapping functionality from 
+> the API to the library piece by piece.
+
+> This enables the wrapper to be loosely coupled to the current implementation of
+> the API, which makes it more resilient to change. Also, this approach takes much
+> less code and maintenance effort, allowing the developer to be lazy. A
+> reasonable person might fairly assume this to be the true rationale behind the
+> philosophy. They'd be right.
+
+My "strong inspiration" is almost entirely motivated by the latter part
+of Philip's philosophy :)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'northpasser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install northpasser
+
+## Usage
+
+This gem is a lightweight API wrapper. That means you'll need to refer to the
+[API documentation](https://app.northpass.com/api/v1/) to figure out what resources
+ and actions exist.
+
+
+Instantiate an object to interface with the API:
+
+```ruby
+northpass = Northpasser::Northpass.new(<YOUR NORTHPASS API TOKEN>)
+```
+
+The API can also provide responses in CSV format instead of the default JSON:
+
+```ruby
+northpass = Northpasser::Northpass.new(<YOUR NORTHPASS API TOKEN>, response_format: :csv)
+```
+
+Then, call methods on the object matching the resource(s) and action you are
+interested in. For example, if you want to list all available courses, you need to
+access the endpoint at https://api.northpass.com/v1/courses. The 
+northpasser gem uses an explicit action:
+
+```ruby
+northpass.courses.list
+# => {
+#  "links": {
+#    "self": "https://api.northpass.com/v1/courses"
+#  },
+#  "data": [
+#    {
+#      "type": "courses",
+#      "id": "72673479-ad0c-4e81-bb2f-47174ff09396",
+#      "attributes": {
+#        "name": "Getting Started with Pixel (Sample Course)",
+#        "enrollments_count": 0,
+#        "list_image_url": "https://d3p3alwwakpeoy.cloudfront.net/api/file/YKu1Zb0fSqmrpsNL7nbu/convert?cache=true&fit=crop&h=500&w=820",
+#        "course_enrollment_link": "https://shipt.schoolkeep.com/c/071e0fd038cb23f005d5ff3f9519a8266774eafe",
+#        "share_course_link": "https://shipt.schoolkeep.com/outline/j16njpjy/cover",
+#        "permalink": "j16njpjy",
+#        "created_at": "2017-11-10T20:09:53Z",
+#        "updated_at": "2017-11-10T20:09:53Z"
+#      },
+#      "relationships": {
+#        "categories": {
+#          "data": []
+#        },
+#        "instructor_partnerships": {
+#          "data": []
+#        }
+#      },
+#      "links": {
+#        "self": "https://api.northpass.com/v1/courses/j16njpjy",
+#        "teaching": "https://app.northpass.com/courses/j16njpjy",
+#        "build": {
+#          "href": "https://app.northpass.com/courses/j16njpjy/builder",
+#          "methods": [
+#            "get"
+#          ]
+#        }
+#      }
+#    }
+```
+
+If the endpoint you want requires parameters, say if you wanted to create a
+learner, you provide a hash to the action call following the resource:
+
+```ruby
+northpass.learners.create(data: { type: 'people', attributes: {email: "spiderman@marvel.com"} })
+# => {
+#  "data": {
+#    "type": "people",
+#    "id": "b813a22e-7442-449b-a150-d3275a2cee29",
+#    "attributes": {
+#      "created_at": "2018-04-06T16:05:17Z",
+#      "email": "spiderman@marvel.com",
+#      "updated_at": "2018-04-06T16:05:17Z",
+#      "unsubscribed": false
+#    },
+#    "links": {
+#      "self": "https://api.northpass.com/v1/people/b813a22e-7442-449b-a150-d3275a2cee29",
+#      "teaching": "https://app.northpass.com/people/b813a22e-7442-449b-a150-d3275a2cee29"
+#    },
+#    "relationships": {
+#      "school": {
+#        "data": {
+#          "type": "schools",
+#          "id": "3825127e-011b-4b71-a6bb-543244406292"
+#        }
+#      }
+#    }
+#  }
+#}
+```
+
+If you are building a path and you make a mistake, you can clear the path:
+
+```ruby
+northpass.courses
+northpass.epics
+northpass.clear_path
+# => []
+```
+
+You don't need to clear the path after a complete request, as that happens
+automatically.
+
+
+The resources and methods are enumerated in the source code
+[here](https://github.com/mrkhutter/northpasser/blob/master/lib/northpasser/constants.rb)
+but generally you should find the url you are interested in from the docs.
+
+## Errors
+
+Errors are passed through from the API relatively undecorated:
+
+```ruby
+northpass = Northpasser::Northpass.new("unrecognized token")
+northpass.courses.list
+# => {
+#  "errors": [
+#    {
+#      "status": "401",
+#      "title": "Unauthorized",
+#      "detail": "You don't have the necessary credentials",
+#      "source": {}
+#    }
+#  ]
+#}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies and
+following the instructions. Specifically, you can choose to provide a genuine
+northpass API token in the `.env` file. This will be important if you want to
+use `bin/console` for an interactive prompt that allows you to experiment with
+the gem and real API responses.
+
+Use `rake spec` to run the tests. The tests don't make external requests but
+rather use VCR for stubbed responses. If you want to play with the tests and
+get real API responses (perhaps to extend the suite or for a new feature) then
+you'll need to have an API token in the env as described above.
+
+The current test suite is far from exhaustive and could do with some
+love.
+
+**NB: If you have implemented a feature that requires a new cassette, make sure
+you change the uri referenced by the cassette you added to remove the API token
+if you have updated the environment to use your token. Otherwise your API token
+will be in publically visible from the code in this repo.**
+
+## Contributing
+
+Bug reports and pull requests are entirely welcome on GitHub at
+https://github.com/philipcastiglione/northpasser.
+
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "northpasser"
+require "dotenv"
+require "irb"
+
+Dotenv.load
+IRB.start

data/bin/setup

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+touch .env
+if [[ $(grep NORTHPASS_API_TOKEN .env) == "" ]]; then
+  echo "NORTHPASS_API_TOKEN=<YOUR NORTHPASS API TOKEN>" >> .env
+  echo ;
+  echo "DEVELOPER: Please edit .env to contain your northpass api token if you wish to use the console."
+  echo ;
+fi

data/lib/northpasser/constants.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'csv'
+
+module Northpasser
+  V1_API_URL = "https://api.northpass.com/v1/".freeze
+
+  # Response formats the northpass api knows about
+  FORMATS = {
+    json: {
+      headers: { header: 'Content-Type', content: 'application/json' },
+      parser: JSON
+    },
+    csv: {
+      headers: { header: 'Accept', content: 'text/csv' },
+      parser: CSV
+    }
+  }.freeze
+
+  # Action words are nice for our internal api and match the api path too
+  ACTIONS = {
+    get: :Get,
+    update: :Put,
+    delete: :Delete,
+    list: :Get,
+    create: :Post
+  }.freeze
+
+  # These are the resource for the northpass api and can form part of the path
+  RESOURCES = [
+    :assignments,
+    :categories,
+    :coupons,
+    :courses,
+    :groups,
+    :learners,
+    :memberships,
+    :people,
+    :quizzes
+  ].freeze
+
+  # These are the annoying edge cases in the northpass api that are don't fit
+  EXCEPTIONS = {
+    bulk_people: {
+      path: "bulk/people",
+      action: :Post
+    },
+    bulk_groups: {
+      path: "bulk/groups",
+      action: :Post
+    }
+  }.freeze
+end

data/lib/northpasser/path_builder.rb

@@ -0,0 +1,90 @@
+module Northpasser
+  module PathBuilder
+    def self.included(_)
+      class_exec do
+        attr_accessor :path
+      end
+    end
+
+    # Uh oh! This will allow the class including this module to "build a path"
+    # by chaining calls to resources, terminated with a method linked to an
+    # action that will execute the api call.
+    #
+    # For example:
+    #
+    # `foo.stories(story_id).comments.update(id: comment_id, text: "comment text")`
+    #
+    # This example will execute a call to:
+    #
+    # `https://api.northpass.com/api/v1/courses/{course-id}/comments/{comment-id}`
+    #
+    # with arguments:
+    #
+    #   `{ text: "comment text" }`
+    #
+    def method_missing(name, *args)
+      if known_action?(name)
+        execute_request(ACTIONS[name], args.first)
+      elsif known_resource?(name)
+        build_path(name, args.first)
+      elsif known_exception?(name)
+        build_path(EXCEPTIONS[name][:path], nil)
+        execute_request(EXCEPTIONS[name][:action], args.first)
+      else
+        super
+      end
+    end
+
+    # You can build a path without executing in stages like this:
+    #
+    # `foo.stories(story_id)`
+    #
+    # This will partly populate foo:path, but won't execute the call (which
+    # clears it). In case you made a mistake and want to start again, you can
+    # clear the path using this public method.
+    #
+    def clear_path
+      self.path = []
+    end
+
+    # We'd better not lie when asked.
+    #
+    def respond_to_missing?(name, include_private = false)
+      known_action?(name) ||
+        known_resource?(name) ||
+        known_exception?(name) ||
+        super
+    end
+
+    private
+
+    def known_action?(name)
+      ACTIONS.keys.include?(name)
+    end
+
+    def known_resource?(name)
+      RESOURCES.include?(name)
+    end
+
+    def known_exception?(name)
+      EXCEPTIONS.keys.include?(name)
+    end
+
+    def execute_request(action, params)
+      req = Request.new(
+        self, 
+        action: action,
+        params: params
+      )
+      clear_path
+      req.fetch
+    end
+
+    def build_path(resource, id)
+      self.path ||= []
+      self.path << resource
+      self.path << id if id
+      self
+    end
+  end
+end

data/lib/northpasser/request.rb

@@ -0,0 +1,78 @@
+require 'net/http'
+require 'pry'
+
+module Northpasser
+  class Request
+    attr_accessor :uri, :action, :response_format, :params
+
+    # Prepares a fancy request object and ensures the inputs make as much sense
+    # as possible. It's still totally possible to just provide a path that
+    # doesn't match a real url though.
+    #
+    def initialize(northpass, action:, params: {})
+      raise ArgumentError unless validate_input(northpass, action, params)
+
+      self.params = params || {}
+      self.uri = construct_uri(northpass)
+      self.action = action
+      self.response_format = northpass.response_format
+    end
+
+    # Executes the http(s) request and provides the response with some
+    # additional decoration in a Hash.
+    #
+    def fetch
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |https|
+        req = Net::HTTP.const_get(action).new(uri)
+
+        set_body(req)
+        set_format_header(req)
+
+        wrap_response(https.request(req))
+      end
+    end
+
+    private
+
+    def validate_input(northpass, action, params)
+      northpass.is_a?(Northpass) &&
+        !northpass.path.nil? &&
+        !northpass.token.nil? &&
+        !northpass.response_format.nil? &&
+        ACTIONS.values.include?(action) &&
+        (params.is_a?(Hash) || params.nil?)
+    end
+
+    def construct_uri(northpass)
+      base_url = V1_API_URL
+      path = northpass.path.map(&:to_s).map { |p| p.gsub('_', '-') }.join('/')
+      object_id = "/#{self.params.delete(:id)}" if self.params.key?(:id)
+      token = northpass.token
+      URI("#{base_url}#{path}#{object_id}?api_key=#{token}")
+    end
+
+    def set_format_header(req)
+      format_header = FORMATS[response_format][:headers][:header]
+      format_content = FORMATS[response_format][:headers][:content]
+      req[format_header] = format_content
+    end
+
+    def set_body(req)
+      req.body = params.to_json if params
+    end
+
+    def wrap_response(res)
+      begin
+        content = FORMATS[response_format][:parser].parse(res.body) if res.body
+      rescue FORMATS[response_format][:parser]::ParserError
+        content = res.body
+      end
+
+      {
+        code: res.code,
+        status: res.message,
+        content: content
+      }
+    end
+  end
+end

data/lib/northpasser/version.rb

@@ -0,0 +1,3 @@
+module Northpasser
+  VERSION = "0.1.1"
+end

data/lib/northpasser.rb

@@ -0,0 +1,28 @@
+require "northpasser/version"
+require "northpasser/constants"
+require "northpasser/path_builder"
+require "northpasser/request"
+
+module Northpasser
+  class Northpass
+    include PathBuilder
+
+    attr_accessor :token, :response_format
+
+    # This is the basic object to interact with the northpass api. An api token
+    # is required, and optionally the response format can be set.
+    #
+    def initialize(token, response_format: :json)
+      raise ArgumentError unless input_valid?(token, response_format)
+
+      self.token = token
+      self.response_format = response_format
+    end
+
+    private
+
+    def input_valid?(token, response_format)
+      !token.nil? && FORMATS.keys.include?(response_format)
+    end
+  end
+end

data/northpasser.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'northpasser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "northpasser"
+  spec.version       = Northpasser::VERSION
+  spec.authors       = ["Mark Hutter"]
+  spec.email         = ["mrkhutter@gmail.com"]
+
+  spec.summary       = %q{A lightweight ruby wrapper for the Northpass API: https://northpass.com/api/v1}
+  spec.homepage      = "https://github.com/mrkhutter/northpasser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.1"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "vcr", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: northpasser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mark Hutter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- mrkhutter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/northpasser.rb
+- lib/northpasser/constants.rb
+- lib/northpasser/path_builder.rb
+- lib/northpasser/request.rb
+- lib/northpasser/version.rb
+- northpasser.gemspec
+homepage: https://github.com/mrkhutter/northpasser
+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.4.8
+signing_key: 
+specification_version: 4
+summary: 'A lightweight ruby wrapper for the Northpass API: https://northpass.com/api/v1'
+test_files: []