strongmind-schoology-client 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 159bb005234f79cb05952d04e5c8df61ea13c93d39947bf324803faf291a3f43
-  data.tar.gz: '06921f258d447fa3c5a11eddba6887b3edceb52c009af251773d908954de0796'
+  metadata.gz: 271745541c3bb94e1ef9eded32dd55cf25bc3d78913b02214244f33ac2fb1456
+  data.tar.gz: d2b1548b934b5cd2779864d22ce82417b6438eae8d6081b8e45f96f5eaf1a8ce
 SHA512:
-  metadata.gz: 32eba4f569170e2e4ab5046b933a83e4f03caa3c5ce787f05d1a69772e1ae8c2f9bbca039dc5378c82d43a29d3f0830bce661806a54bc48b3ae7054fd9e96f43
-  data.tar.gz: 7ce82c65442e995394e9b006d12b57f14b5e08769c129f0b29ab5f66311eefda5bfd351ee776abfbb883730dd079c575638d8937cb54e679da1ee102f7a5aad8
+  metadata.gz: fc5cebfd760eb646c78e27693524e651dd90b63516f77d58df9c1f0bce382bf27028948504fdb63aa7e4d5d7ca572507efd3abd6f8134f816696d181e5cd4a97
+  data.tar.gz: 78bd3b4d61b96a38338ee5af1a554ac0cd1e199634d589eaf63963a2462893d975cdec52eb2773e1803bfeaf91783d1b7b2544a32ef97f3bc518fb38946dd93f

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/Gemfile

@@ -10,3 +10,7 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'oauth'

data/Gemfile.lock

@@ -1,15 +1,88 @@
 PATH
   remote: .
   specs:
-    schoology (0.1.0)
-      faraday
-      faraday_middleware
+    strongmind-schoology-client (0.1.2)
+      faraday (~> 1.1)
+      faraday_middleware (~> 1.2)
+      oauth (~> 1.1)
+      rails (~> 7.0)
+      railties (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    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)
@@ -35,11 +108,76 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
+    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)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    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
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.14.3-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)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.0)
@@ -71,17 +209,33 @@ 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)
+    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)
+    zeitwerk (2.6.8)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-darwin-20
   x86_64-darwin-21
 
 DEPENDENCIES
+  faraday
+  faraday_middleware
+  oauth
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
-  schoology!
+  strongmind-schoology-client!
 
 BUNDLED WITH
    2.3.6

data/lib/schoology_client/client.rb

@@ -0,0 +1,56 @@
+# 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
+    end
+
+    def group
+      GroupResource.new(self)
+    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
+    end
+
+  end
+end
+

data/lib/schoology_client/configuration.rb

@@ -0,0 +1,12 @@
+module SchoologyClient
+  class Configuration
+    attr_accessor :oauth_consumer_key, :oauth_consumer_secret, :url
+
+    def initialize
+      @oauth_consumer_key = nil
+      @oauth_consumer_secret = nil
+      @url = nil
+    end
+
+  end
+end

data/lib/schoology_client/error.rb

@@ -0,0 +1,4 @@
+module SchoologyClient
+  class Error < StandardError
+  end
+end

data/lib/schoology_client/generators/schoology_api/install_generator.rb

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

data/lib/{schoology-client → schoology_client}/resource.rb

@@ -9,7 +9,7 @@ module SchoologyClient
     end
 
     def post_request(url, body:, headers: {})
-      handle_response client.connection.post(url, body, headers)
+      handle_response @client.connection.post(url, body, headers)
     end
 
     def handle_response(response)

data/lib/schoology_client/resources/group.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+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)
+    end
+  end
+end
+

data/lib/{schoology-client → schoology_client}/version.rb

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

data/lib/schoology_client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require "rails/all"
+require_relative "schoology_client/version"
+
+
+module SchoologyClient
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  autoload :Client, "schoology_client/client"
+  autoload :Configuration, "schoology_client/configuration"
+  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"
+
+  # Classes used to return a nicer object wrapping the response data
+  autoload :Group, "schoology/objects/group"
+
+  def self.configuration
+    @configuration ||= SchoologyClient::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def initialize
+    @oauth_consumer_key = self.class.configuration.oauth_consumer_key
+    @oauth_consumer_secret = self.class.configuration.oauth_consumer_secret
+    @url = self.class.configuration.url
+  end
+end

data/lib/templates/schoology_client_initializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+SchoologyClient.configure do |config|
+
+  # Schoology OAuth consumer key and secret can be found at https://app.schoology.com/api
+  config.oauth_consumer_key = ENV['SCHOOLOGY_OAUTH_CONSUMER_KEY']
+  config.oauth_consumer_secret = ENV['SCHOOLOGY_OAUTH_CONSUMER_SECRET']
+
+  # This is the base URL for the Schoology API. It should be set to
+  # to something like 'https://api.schoology.com/v1'
+  config.url = ENV['SCHOOLOGY_API_URL']
+
+end

metadata

@@ -1,43 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-schoology-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Strongmind
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: 
 email:
 - qwertytalk@strongmind.com
@@ -47,19 +89,25 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODEOWNERS
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
-- lib/schoology-client.rb
-- lib/schoology-client/client.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/schoology_client.rb
+- 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/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: []

data/lib/schoology-client/client.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module SchoologyClient
-  class Client
-    BASE_URL = "https://schoologysandbox.schoology.com/v1"
-
-    attr_reader :oauth_token, :adapter
-
-    def initialize(oauth_token:, adapter: Faraday.default_adapter, stubs: nil)
-      @oauth_token = oauth_token
-      @adapter = adapter
-      #used for tests
-      @stubs = stubs
-    end
-
-    def group
-      GroupResource.new(self)
-    end
-
-    def connection
-      @connection ||= Faraday.new(BASE_URL) do |conn|
-        conn.request :authorization, :Bearer, oauth_token
-        conn.request :json
-
-        conn.response :dates
-        conn.response :json, content_type: "application/json"
-
-        conn.adapter adapter, @stubs
-      end
-    end
-  end
-end
-

data/lib/schoology-client/resources/group.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module SchoologyClient
-  class GroupResource < Resource
-    def create(**attributes)
-      GroupResource.new post_request("groups", body: attributes).body
-    end
-  end
-end
-

data/lib/schoology-client.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require "faraday"
-require "faraday_middleware"
-require_relative "schoology-client/version"
-
-module SchoologyClient
-  autoload :Client, "schoology-client/client"
-  autoload :Object, "schoology-client/object"
-  autoload :Resource, "schoology-client/resource"
-
-  # High-level categories of Schoology API calls
-  autoload :GroupResource, "schoology-client/resources/group"
-
-  # Classes used to return a nicer object wrapping the response data
-  autoload :Group, "schoology/objects/group"
-end