strongmind-schoology-client 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae95f00744a8364f799342056301ff99f387a757117fce80f3d0819530fc20c0
-  data.tar.gz: a5a88caa7e2dbbb42f4d54662e38ff42b75b22a665d8ad2ba110a4c5135dbd21
+  metadata.gz: 1b4adaea90620c1414be5f78d31cba6f521114b6692f1b5917b93eda23857169
+  data.tar.gz: 624f6830f28c28ea5261be09495440cb2bdfa527e5d69c5e67f9c1ac8afd820d
 SHA512:
-  metadata.gz: 33a8aa9d22200d827dc09189f705b2ff1c9f721e3733de1b9283e8264bc664a48697a5ae428e5d9f64f0c09b2ce82f11aaf7a13bcf94d3af27c1f72f025f21e6
-  data.tar.gz: 7b3a45d2eb4531ef612056ff3bfa433df05e114c5580444a371d280e52dfbb63950e852311ffa02f4918cd4ff63f047252c313b33f068a8704fcb1b0404d949e
+  metadata.gz: a2ca0fcdf5eb50bc8826cc2e041de18aae11501eb3c8df2bfcbaa09a46f03265d67d73f73f24c01bca6b784aa61a0606b9ca3b57e0727244c1dff034118dccfb
+  data.tar.gz: b334eade9ffe19115844aee89b0b6374bf5a730308ba58f03823018a3227109165ce128207cc1a7a3c9d7bffd109f13c1545e4b704f7559eed6e8e6212f918d8

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,9 +1,8 @@
 PATH
   remote: .
   specs:
-    strongmind-schoology-client (0.1.2)
-      faraday (~> 1.1)
-      faraday_middleware (~> 1.2)
+    strongmind-schoology-client (0.1.3)
+      faraday (>= 2.0)
       rails (~> 7.0)
       railties (~> 7.0)
       simple_oauth (~> 0.3.1)
@@ -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)
@@ -210,15 +182,11 @@ GEM
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simple_oauth (0.3.1)
-    snaky_hash (2.0.1)
-      hashie
-      version_gem (~> 1.1, >= 1.1.1)
-    thor (1.2.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)
@@ -230,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 'simple_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,18 +28,7 @@ module SchoologyClient
     end
 
     def connection
-      # setup faraday connection using 2-legged oauth 1.0
-      connection = Faraday.new(url: @url) do |faraday|
-        faraday.request :json
-        faraday.request :oauth, {
-          consumer_key: @oauth_consumer_key,
-          consumer_secret: @oauth_consumer_secret
-        }
-
-        faraday.response :json
-        faraday.adapter @adapter, @stubs
-      end
-      connection
+      @connection
     end
 
   end

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/resource.rb

@@ -12,6 +12,10 @@ module SchoologyClient
       handle_response @client.connection.post(url, body, headers)
     end
 
+    def put_request(url, body:, headers: {})
+      handle_response @client.connection.put(url, body, headers)
+    end
+
     def handle_response(response)
       case response.status
       when 400

data/lib/schoology_client/resources/group.rb

@@ -6,6 +6,10 @@ module SchoologyClient
     def create(**attributes)
       GroupResource.new post_request("groups", body: attributes.to_json).body
     end
+
+    def update(id, **attributes)
+      GroupResource.new put_request("groups/#{id}", 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.3"
+  VERSION = "0.1.5"
 end

data/lib/schoology_client.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday_middleware"
 require "rails"
 require_relative "schoology_client/version"
 
@@ -23,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,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-schoology-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Strongmind
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-06-21 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: simple_oauth
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +88,7 @@ files:
 - lib/schoology_client/error.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