real_savvy 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ec995c778fa1380bda1308281b30d8d143ad78a
-  data.tar.gz: a87ce301ef34291b8c1679c2c9c01cad51453631
+  metadata.gz: f7b745a34a03293650d40a5d016eaca8eaa520cd
+  data.tar.gz: 3f7a21b2a041fc50f51fc9dd3d88525cfeeb8e21
 SHA512:
-  metadata.gz: 2ba195c43226ec745e1d345675cd5ebaa00c0b0c08e6e1536e5dce6f8dcddf695bb89974b9f1e3e2ab02c6d4897ac715097c0a905af49f3c6d3c7145dcd8ca63
-  data.tar.gz: 02c061df9794ec1ba497fbda7e593c9fc80e5dae445b5517a902a49f86cf00fbee24ca091de265de77449365a2d1ce78c28e7f61ebb20b5c4dafe0bfae18bf85
+  metadata.gz: 749686a2e8f5800286e6fa1fc6b312aac07160f3edc281a5ef865c66422d03291ceffc3d3b18264dba42863800bdc6afb292c446a9226f2e4b3916e0883008e8
+  data.tar.gz: e0d40049f1d30440f505cc54e335b4a8991d285887fcb9bde52ffea859ba8265f3139bc16bee9cd2da963a76c4af42fa20a2e071fe3b68dfa35a458f90d90ab1

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    real_savvy (0.0.4)
+      faraday (>= 0.10.0)
+      faraday_middleware (>= 0.10.0)
+      jwt (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    jwt (1.5.6)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    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.0)
+    rspec_junit_formatter (0.3.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  pry (~> 0.10)
+  rake (~> 10.0)
+  real_savvy!
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.3)
+
+BUNDLED WITH
+   1.15.4

data/lib/real_savvy.rb

@@ -12,3 +12,4 @@ module RealSavvy
 end
 
 require 'real_savvy/client'
+require 'real_savvy/jwt'

data/lib/real_savvy/jwt.rb

@@ -0,0 +1,8 @@
+require 'jwt'
+
+module RealSavvy::JWT
+
+end
+
+require 'real_savvy/jwt/token'
+Dir[File.dirname(__FILE__) + '/jwt/*.rb'].each {|file| require file }

data/lib/real_savvy/jwt/bad_credentials.rb

@@ -0,0 +1,6 @@
+module RealSavvy
+  module JWT
+    class BadCredentials < StandardError
+    end
+  end
+end

data/lib/real_savvy/jwt/imposter.rb

@@ -0,0 +1,9 @@
+module RealSavvy
+  module JWT
+    module Imposter
+      def is_real_savvy_imposter
+        true
+      end
+    end
+  end
+end

data/lib/real_savvy/jwt/site.rb

@@ -0,0 +1,9 @@
+module RealSavvy
+  module JWT
+    module Site
+      def is_real_savvy_site?
+        true
+      end
+    end
+  end
+end

data/lib/real_savvy/jwt/token.rb

@@ -0,0 +1,187 @@
+module RealSavvy
+  module JWT
+    class Token
+      # In order of access level
+      SCOPE_VERBS = %w{public read write admin}.freeze
+
+      attr_reader :scopes, :user, :site, :token
+
+      def initialize(token)
+        @token = token
+        retrieve_claims
+        retrieve_scopes
+        retrieve_audience
+        retrieve_site
+        retrieve_subject
+        retrieve_user
+      end
+
+      def self.public_key
+        if block_given?
+          @public_key = Proc.new
+        else
+          result = @public_key.is_a?(Proc) ? @public_key.call : @public_key
+          result.is_a?(OpenSSL::PKey::RSA) ? result : OpenSSL::PKey::RSA.new(result)
+        end
+      end
+
+      def self.public_key= value
+        @public_key = value
+      end
+
+      def self.retrieve_audience claims = nil
+        if block_given?
+          @retrieve_audience = Proc.new
+        else
+          @retrieve_audience.call(claims)
+        end
+      end
+
+      def self.retrieve_audience= value
+        @retrieve_audience = value
+      end
+
+      def self.retrieve_subject claims = nil
+        if block_given?
+          @retrieve_subject = Proc.new
+        else
+          @retrieve_subject.call(claims)
+        end
+      end
+
+      def self.retrieve_subject= value
+        @retrieve_subject = value
+      end
+
+      def self.validate_token token = nil
+        if block_given?
+          @validate_token = Proc.new
+        else
+          @validate_token.call(token)
+        end
+      end
+
+      def self.validate_token= value
+        @validate_token = value
+      end
+
+      def self.decode(token)
+        new(token)
+      end
+
+      def scope_includes?(*scope_parts)
+        !scope_parts.empty? && (
+          scope_parts = scope_parts.dup.map(&:to_s)
+          verbs_matches = self.class.verbs_matches(scope_parts.pop)
+
+          (0..scope_parts.length).any? do |depth|
+            verbs_matches.any? do |verb|
+              (scope_parts[0...depth] + [verb]).inject(scopes) do |m, v|
+                m&.[](v)
+              end
+            end
+          end
+        )
+      end
+
+      def scope_includes!(*scope_parts)
+        scope_includes?(*scope_parts) || fail(JWTUnauthorized)
+      end
+
+      def self.verbs_matches(verb)
+        verb_index = SCOPE_VERBS.index(verb)
+        verb_index ? SCOPE_VERBS[verb_index..-1] : []
+      end
+
+      def for_site?
+        audience_is_site? && subject_is_site?
+      end
+
+      def for_site!
+        for_site? || fail(JWTUnauthorized)
+      end
+
+      def for_user?
+        audience_is_site? && (subject_is_user? || subject_is_imposter?)
+      end
+
+      def audience_is_site?
+        audience.respond_to?(:is_real_savvy_site?) &&
+        audience.is_real_savvy_site?
+      end
+
+      def subject_is_user?
+        subject.respond_to?(:is_real_savvy_user?) &&
+        subject.is_real_savvy_user?
+      end
+
+      def subject_is_imposter?
+        subject.respond_to?(:is_real_savvy_imposter?) &&
+        subject.is_real_savvy_imposter?
+      end
+
+      def subject_is_site?
+        subject.respond_to?(:is_real_savvy_site?) &&
+        subject.is_real_savvy_site?
+      end
+
+      def for_user!
+        for_user? || fail(JWTUnauthorized)
+      end
+
+      def valid?
+        claims && claims.length > 0 && (for_site? || for_user?) && self.class.validate_token(token)
+      end
+
+      def imposter?
+        @imposter ? true : false
+      end
+
+      private
+
+      attr_reader :claims, :audience, :subject
+
+      def retrieve_claims
+        @claims = ::JWT.decode(
+          token,
+          self.class.public_key,
+          true,
+          algorithm: 'RS256',
+        ).first
+      rescue ::JWT::DecodeError => e
+        raise RealSavvy::JWT::BadCredentials.new(e.message)
+      end
+
+      def retrieve_audience
+        @audience = self.class.retrieve_audience(claims) if claims
+      end
+
+      def retrieve_subject
+        @subject = self.class.retrieve_subject(claims) if claims
+      end
+
+      def retrieve_site
+        @site = audience
+      end
+
+      def retrieve_user
+        if subject_is_user?
+          @user = subject
+        elsif subject_is_imposter?
+          @user = subject.user
+          @imposter = true
+        end
+      end
+
+      def raw_scopes
+        claims&.fetch('scopes', nil).to_a
+      end
+
+      def retrieve_scopes
+        @scopes = raw_scopes.each_with_object({}) do |scope, result|
+          scope.split(':').inject(result) { |m, v| m[v] ||= {} }
+        end
+      end
+    end
+  end
+end

data/lib/real_savvy/jwt/unauthorized.rb

@@ -0,0 +1,6 @@
+module RealSavvy
+  module JWT
+    class Unauthorized < StandardError
+    end
+  end
+end

data/lib/real_savvy/jwt/user.rb

@@ -0,0 +1,9 @@
+module RealSavvy
+  module JWT
+    module User
+      def is_real_savvy_user?
+        true
+      end
+    end
+  end
+end

data/lib/real_savvy/version.rb

@@ -1,3 +1,3 @@
 module RealSavvy
-  VERSION = [0,0,3]
+  VERSION = [0,0,4]
 end

data/real_savvy.gemspec

@@ -23,9 +23,11 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'faraday', ">= 0.10.0"
   spec.add_runtime_dependency 'faraday_middleware', ">= 0.10.0"
+  spec.add_runtime_dependency 'jwt', ">= 1.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: real_savvy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ryan Rauh
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,6 +40,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -96,14 +110,30 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: A gem for connecting to RealSavvy V3 API
 email: andrew@realsavvy.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - bin/console
 - bin/setup
@@ -115,7 +145,7 @@ files:
 - lib/real_savvy/adapter/base.rb
 - lib/real_savvy/adapter/broker_office.rb
 - lib/real_savvy/adapter/collection.rb
-- lib/real_savvy/adapter/markets.rb
+- lib/real_savvy/adapter/market.rb
 - lib/real_savvy/adapter/open_house.rb
 - lib/real_savvy/adapter/property.rb
 - lib/real_savvy/adapter/saved_search.rb
@@ -134,6 +164,13 @@ files:
 - lib/real_savvy/concern/update_for_adapter.rb
 - lib/real_savvy/connection.rb
 - lib/real_savvy/document.rb
+- lib/real_savvy/jwt.rb
+- lib/real_savvy/jwt/bad_credentials.rb
+- lib/real_savvy/jwt/imposter.rb
+- lib/real_savvy/jwt/site.rb
+- lib/real_savvy/jwt/token.rb
+- lib/real_savvy/jwt/unauthorized.rb
+- lib/real_savvy/jwt/user.rb
 - lib/real_savvy/links.rb
 - lib/real_savvy/meta.rb
 - lib/real_savvy/resource.rb