northpasser 0.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2c8333ec38144509f7e478cd4544c40d201e0f5
-  data.tar.gz: c68a0ac87b76aff966d19dbfb97c3ac2a8e72a26
+  metadata.gz: 0db00a9394417615c31a808555aecaf053a59e82
+  data.tar.gz: 3398492a360bf5ce2d9088abad5fd32c5c60f62e
 SHA512:
-  metadata.gz: a6ef1acd78ef23c0e82e233c5e64485ca3e6021a3f792b6da2fcc4f9bc3b2e04512688430dad586d42370730e22034d72ff635d245cf9c998d9d99695a8defcc
-  data.tar.gz: 377280e37600ff6da3dae89c7b86cfd7c8d899559d662d7078bf0cb7571993163d8c16c746fe47fad24c95a7fafab40d908ee939067e2b9667f9ab952cd7651a
+  metadata.gz: 8b71a66c56fbea1b14eae44c3b70f3bcbccacd0ebf18fd0753bd257c2ad37c3d29941d19069313b8233f7e37cb34bad17c6a0416f7a0e51d8acbd6331b3234f7
+  data.tar.gz: e65295a5c4cc88365088c9064223bd32d74d325c65eca842499205fcfdd38bb4216f21eed88adf813cfd27d037d111da9d433c3f4836c711fde54d42b7cd5b15

data/.gitignore

@@ -1,2 +1,2 @@
 .env
-*.gem
+coverage/*

data/Gemfile.lock

@@ -41,7 +41,6 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    vcr (3.0.3)
     webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
@@ -58,8 +57,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.0)
   simplecov
-  vcr (~> 3.0)
   webmock (~> 2.1)
 
 BUNDLED WITH
-   1.15.4
+   1.16.1

data/README.md

@@ -184,22 +184,18 @@ 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.
+rather use WebMock to mock Northpass API calls. This allows you to run and develop
+directly against the Northpass API without needing a valid Northpass API token.
+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.
+https://github.com/mrkhutter/northpasser.
 
 
 ## License

data/lib/northpasser.rb

@@ -1,5 +1,7 @@
 require "northpasser/version"
-require "northpasser/constants"
+require "northpasser/versionless_constants"
+require "northpasser/v1_constants"
+require "northpasser/v2_constants"
 require "northpasser/path_builder"
 require "northpasser/request"
 

data/lib/northpasser/path_builder.rb

@@ -2,7 +2,7 @@ module Northpasser
   module PathBuilder
     def self.included(_)
       class_exec do
-        attr_accessor :path
+        attr_accessor :path, :version_url
       end
     end
 
@@ -26,6 +26,7 @@ module Northpasser
       if known_action?(name)
         execute_request(ACTIONS[name], args.first)
       elsif known_resource?(name)
+        build_version_url(name)
         build_path(name, args.first)
       elsif known_exception?(name)
         build_path(EXCEPTIONS[name][:path], nil)
@@ -63,7 +64,15 @@ module Northpasser
     end
 
     def known_resource?(name)
-      RESOURCES.include?(name)
+      known_v1_resource?(name) || known_v2_resource?(name)
+    end
+
+    def known_v1_resource?(name)
+      V1_RESOURCES.include?(name)
+    end
+
+    def known_v2_resource?(name)
+      V2_RESOURCES.include?(name)
     end
 
     def known_exception?(name)
@@ -80,6 +89,14 @@ module Northpasser
       req.fetch
     end
 
+    def build_version_url(name)
+      self.version_url = V1_API_URL
+      if known_v2_resource?(name)
+        self.version_url = V2_API_URL
+      end
+      self
+    end
+
     def build_path(resource, id)
       self.path ||= []
       self.path << resource

data/lib/northpasser/request.rb

@@ -43,7 +43,7 @@ module Northpasser
     end
 
     def construct_uri(northpass)
-      base_url = V1_API_URL
+      base_url = northpass.version_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

data/lib/northpasser/v1_constants.rb

@@ -0,0 +1,31 @@
+require 'json'
+require 'csv'
+
+module Northpasser
+  V1_API_URL = "https://api.northpass.com/v1/".freeze
+
+  # These are the resource for the northpass v1 api and can form part of the path
+  V1_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/v2_constants.rb

@@ -0,0 +1,14 @@
+require 'json'
+require 'csv'
+
+module Northpasser
+  V2_API_URL = "https://api.northpass.com/v2/".freeze
+
+  # These are the resource for the northpass v2 api and can form part of the path
+  V2_RESOURCES = [
+    :activities,
+    :assignment_submissions,
+    :events,
+    :people
+  ].freeze
+end

data/lib/northpasser/version.rb

@@ -1,3 +1,3 @@
 module Northpasser
-  VERSION = "0.1.2"
+  VERSION = "2.0.0"
 end

data/lib/northpasser/versionless_constants.rb

@@ -0,0 +1,26 @@
+require 'json'
+require 'csv'
+
+module Northpasser
+
+  # 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
+end

data/northpasser.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   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"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: northpasser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Mark Hutter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-21 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,21 +81,7 @@ dependencies:
       - !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
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -138,10 +124,12 @@ files:
 - bin/console
 - bin/setup
 - lib/northpasser.rb
-- lib/northpasser/constants.rb
 - lib/northpasser/path_builder.rb
 - lib/northpasser/request.rb
+- lib/northpasser/v1_constants.rb
+- lib/northpasser/v2_constants.rb
 - lib/northpasser/version.rb
+- lib/northpasser/versionless_constants.rb
 - northpasser.gemspec
 homepage: https://github.com/mrkhutter/northpasser
 licenses:

data/lib/northpasser/constants.rb

@@ -1,52 +0,0 @@
-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