strongmind-schoology-client 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271745541c3bb94e1ef9eded32dd55cf25bc3d78913b02214244f33ac2fb1456
-  data.tar.gz: d2b1548b934b5cd2779864d22ce82417b6438eae8d6081b8e45f96f5eaf1a8ce
+  metadata.gz: 3d0ab2bf3b584a58dd5ff1910327b299578cfdca8652626b96875ae8739e8069
+  data.tar.gz: 023bfd2f65938daac6e6a499cbaa779f1a4207665b9a3f2ab02138279d0cf9df
 SHA512:
-  metadata.gz: fc5cebfd760eb646c78e27693524e651dd90b63516f77d58df9c1f0bce382bf27028948504fdb63aa7e4d5d7ca572507efd3abd6f8134f816696d181e5cd4a97
-  data.tar.gz: 78bd3b4d61b96a38338ee5af1a554ac0cd1e199634d589eaf63963a2462893d975cdec52eb2773e1803bfeaf91783d1b7b2544a32ef97f3bc518fb38946dd93f
+  metadata.gz: 82126ddbfac4653562ee968be3e3e20edeef457b75f29b9542354e771a989404c1b201ccb4959769916e7dfa139573f746192b5a2ec07cbbfeb19fa9931ae74a
+  data.tar.gz: 1727d3db2822510fd11b1b5648605156ee4003d1d42efa599ef9ff1a590dbd68d848280e8ac37115b2372a70c4247c627d33bc5ab161e9806cd66ef321c4baed

data/Gemfile

@@ -11,6 +11,5 @@ gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
 
-gem 'faraday'
-gem 'faraday_middleware'
-gem 'oauth'
+gem 'faraday', '>= 2.0'
+gem 'simple_oauth'

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    strongmind-schoology-client (0.1.2)
-      faraday (~> 1.1)
-      faraday_middleware (~> 1.2)
-      oauth (~> 1.1)
+    strongmind-schoology-client (0.1.3)
+      faraday (>= 2.0)
       rails (~> 7.0)
       railties (~> 7.0)
+      simple_oauth (~> 0.3.1)
 
 GEM
   remote: https://rubygems.org/
@@ -83,40 +82,18 @@ GEM
     date (3.3.3)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    faraday (1.10.3)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
+    faraday-net_http (3.0.2)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    hashie (5.0.0)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    loofah (2.20.0)
+    loofah (2.21.2)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -126,7 +103,6 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     minitest (5.18.0)
-    multipart-post (2.3.0)
     net-imap (0.3.4)
       date
       net-protocol
@@ -137,14 +113,10 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.14.3-x86_64-darwin)
+    nokogiri (1.14.4-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.4-x86_64-darwin)
       racc (~> 1.4)
-    oauth (1.1.0)
-      oauth-tty (~> 1.0, >= 1.0.1)
-      snaky_hash (~> 2.0)
-      version_gem (~> 1.1)
-    oauth-tty (1.0.5)
-      version_gem (~> 1.1, >= 1.1.1)
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
@@ -209,15 +181,12 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    snaky_hash (2.0.1)
-      hashie
-      version_gem (~> 1.1, >= 1.1.1)
-    thor (1.2.1)
+    simple_oauth (0.3.1)
+    thor (1.2.2)
     timeout (0.3.2)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    version_gem (1.1.2)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
@@ -229,12 +198,11 @@ PLATFORMS
   x86_64-darwin-21
 
 DEPENDENCIES
-  faraday
-  faraday_middleware
-  oauth
+  faraday (>= 2.0)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  simple_oauth
   strongmind-schoology-client!
 
 BUNDLED WITH

data/lib/schoology_client/client.rb

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 require 'faraday'
-require 'faraday_middleware'
-require 'oauth'
+
 
 module SchoologyClient
   class Client
-    attr_reader :adapter, :oauth_consumer_key, :oauth_consumer_secret, :url, :stubs
-
-    def initialize(adapter: Faraday.default_adapter, stubs: nil)
-      @adapter = adapter
-      @oauth_consumer_key = SchoologyClient.configuration.oauth_consumer_key
-      @oauth_consumer_secret = SchoologyClient.configuration.oauth_consumer_secret
-      @url = SchoologyClient.configuration.url
-
-      #used for specs
-      @stubs = stubs
+    attr_reader :oauth_consumer_key, :oauth_consumer_secret, :url
+
+    def initialize(conn = nil)
+      if conn.nil?
+        # setup faraday connection using 2-legged oauth 1.0
+        @connection = Faraday.new(url: SchoologyClient.configuration.url) do |faraday|
+          faraday.request :json
+          faraday.request :oauth, {
+            consumer_key: SchoologyClient.configuration.oauth_consumer_key,
+            consumer_secret: SchoologyClient.configuration.oauth_consumer_secret
+          }
+
+          faraday.response :json
+        end
+      else
+        @connection = conn
+      end
     end
 
     def group
@@ -22,33 +28,7 @@ module SchoologyClient
     end
 
     def connection
-
-      # Set up the OAuth 1.0 consumer
-      consumer = OAuth::Consumer.new(
-        @oauth_consumer_key,
-        @oauth_consumer_secret,
-        site: @url,
-        scheme: :header,
-        signature_method: 'PLAINTEXT',
-        realm: 'Schoology API'
-      )
-
-      # Set up the Faraday connection
-      connection = Faraday.new("#{@url}") do |conn|
-        conn.request :url_encoded
-        conn.request :json
-
-        conn.response :dates
-        conn.response :json, content_type: "application/json"
-
-        if @stubs
-          conn.adapter adapter, @stubs
-        else
-          conn.adapter adapter
-        end
-      end
-
-      return connection
+      @connection
     end
 
   end

data/lib/schoology_client/generators/{schoology_api → schoology_client}/install_generator.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'rails/generatorsi'
-require 'schoology_client'
+require 'rails/generators/base'
 
-module SchoologyApi
+module SchoologyClient
   module Generators
+
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Generate SchoologyClient initializer file for Rails applications"
+      desc "Generate Strongmind Schoology Client initializer file for Rails applications"
 
       def copy_initializer
         template "schoology_api.rb", "config/initializers/schoology_api.rb"

data/lib/schoology_client/oauth.rb

@@ -0,0 +1,85 @@
+require 'faraday'
+require 'simple_oauth'
+require 'forwardable'
+
+module SchoologyClient
+  # Public: Uses the simple_oauth library to sign requests according the
+  # OAuth protocol.
+  #
+  # The options for this middleware are forwarded to SimpleOAuth::Header:
+  # :consumer_key, :consumer_secret, :token, :token_secret. All these
+  # parameters are optional.
+  #
+  # The signature is added to the "Authorization" HTTP request header. If the
+  # value for this header already exists, it is not overriden.
+  #
+  # If no Content-Type header is specified, this middleware assumes that
+  # request body parameters should be included while signing the request.
+  # Otherwise, it only includes them if the Content-Type is
+  # "application/x-www-form-urlencoded", as per OAuth 1.0.
+  #
+  # For better performance while signing requests, this middleware should be
+  # positioned before UrlEncoded middleware on the stack, but after any other
+  # body-encoding middleware (such as EncodeJson).
+  class OAuth < Faraday::Middleware
+    AUTH_HEADER = 'Authorization'
+    CONTENT_TYPE = 'Content-Type'
+    TYPE_URLENCODED = 'application/x-www-form-urlencoded'
+
+    extend Forwardable
+    def_delegator :'Faraday::Utils', :parse_nested_query
+
+    def initialize(app, options)
+      super(app)
+      @options = options
+    end
+
+    def call(env)
+      env[:request_headers][AUTH_HEADER] ||= oauth_header(env).to_s if sign_request?(env)
+      @app.call(env)
+    end
+
+    def oauth_header(env)
+      SimpleOAuth::Header.new env[:method],
+                              env[:url].to_s,
+                              signature_params(body_params(env)),
+                              oauth_options(env)
+    end
+
+    def sign_request?(env)
+      !!env[:request].fetch(:oauth, true)
+    end
+
+    def oauth_options(env)
+      if (extra = env[:request][:oauth]) && extra.is_a?(Hash) && !extra.empty?
+        @options.merge extra
+      else
+        @options
+      end
+    end
+
+    def body_params(env)
+      if include_body_params?(env)
+        if env[:body].respond_to?(:to_str)
+          parse_nested_query env[:body]
+        else
+          env[:body]
+        end
+      end || {}
+    end
+
+    def include_body_params?(env)
+      # see RFC 5849, section 3.4.1.3.1 for details
+      !(type = env[:request_headers][CONTENT_TYPE]) || (type == TYPE_URLENCODED)
+    end
+
+    def signature_params(params)
+      if params.empty?
+        params
+      else
+        params.reject { |_k, v| v.respond_to?(:content_type) }
+      end
+    end
+  end
+
+end

data/lib/schoology_client/resources/group.rb

@@ -4,8 +4,7 @@ require 'json'
 module SchoologyClient
   class GroupResource < Resource
     def create(**attributes)
-      response_body = post_request("groups", body: attributes.to_json).body
-      return GroupResource.new(response_body)
+      GroupResource.new post_request("groups", body: attributes.to_json).body
     end
   end
 end

data/lib/schoology_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SchoologyClient
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/schoology_client.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday_middleware"
-require "rails/all"
+require "rails"
 require_relative "schoology_client/version"
 
-
 module SchoologyClient
 
   class << self
@@ -17,7 +15,6 @@ module SchoologyClient
   autoload :Object, "schoology_client/object"
   autoload :Resource, "schoology_client/resource"
   autoload :Error, "schoology_client/error"
-  autoload :Railtie, "schoology_client/railtie"
 
   # High-level categories of Schoology API calls
   autoload :GroupResource, "schoology_client/resources/group"
@@ -25,6 +22,10 @@ module SchoologyClient
   # Classes used to return a nicer object wrapping the response data
   autoload :Group, "schoology/objects/group"
 
+
+  autoload :OAuth,           'schoology_client/oauth'
+  Faraday::Request.register_middleware oauth: -> { OAuth }
+
   def self.configuration
     @configuration ||= SchoologyClient::Configuration.new
   end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-schoology-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Strongmind
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: simple_oauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +86,14 @@ files:
 - lib/schoology_client/client.rb
 - lib/schoology_client/configuration.rb
 - lib/schoology_client/error.rb
-- lib/schoology_client/generators/schoology_api/install_generator.rb
+- lib/schoology_client/generators/schoology_client/install_generator.rb
+- lib/schoology_client/generators/templates/schoology_client_initializer.rb
+- lib/schoology_client/oauth.rb
 - lib/schoology_client/object.rb
 - lib/schoology_client/objects/group.rb
 - lib/schoology_client/resource.rb
 - lib/schoology_client/resources/group.rb
 - lib/schoology_client/version.rb
-- lib/templates/rails/initializer/schoology-client.rb.tt
-- lib/templates/schoology_client_initializer.rb
 - sig/schoology.rbs
 homepage: https://github.com/Strongmind/schoology-client
 licenses: []