strongmind-schoology-client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56a2628a8f8dda5eae583876c5310a1284d904360240ed625004b24fcf59c6b7
-  data.tar.gz: a6b8340d998bf65d6c17b33d3c2764eee3d027e9511ed3389f7bb13d005222ab
+  metadata.gz: 271745541c3bb94e1ef9eded32dd55cf25bc3d78913b02214244f33ac2fb1456
+  data.tar.gz: d2b1548b934b5cd2779864d22ce82417b6438eae8d6081b8e45f96f5eaf1a8ce
 SHA512:
-  metadata.gz: 9708c7c9a7db17cda211539aee89cb122a56d8934aa309351aa54969edeb72b04cb7dae5fcf20ff426c401ffad1748cfb16237c27b3e630b962c67ecd526a19d
-  data.tar.gz: 7a254abdd176875275c775e9d648c44d8f86fd77a540a4334eb58daee1ab7568139f576aa4521ddb509e581358d0345647aaa16b844e966009f65749bebeb441
+  metadata.gz: fc5cebfd760eb646c78e27693524e651dd90b63516f77d58df9c1f0bce382bf27028948504fdb63aa7e4d5d7ca572507efd3abd6f8134f816696d181e5cd4a97
+  data.tar.gz: 78bd3b4d61b96a38338ee5af1a554ac0cd1e199634d589eaf63963a2462893d975cdec52eb2773e1803bfeaf91783d1b7b2544a32ef97f3bc518fb38946dd93f

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    strongmind-schoology-client (0.1.0)
-      faraday (~> 1.x)
+    strongmind-schoology-client (0.1.2)
+      faraday (~> 1.1)
       faraday_middleware (~> 1.2)
       oauth (~> 1.1)
-      pry
-      rails (~> 7.x)
+      rails (~> 7.0)
+      railties (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -78,7 +78,6 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     builder (3.2.4)
-    coderay (1.1.3)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
     date (3.3.3)
@@ -138,8 +137,6 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.14.3-arm64-darwin)
-      racc (~> 1.4)
     nokogiri (1.14.3-x86_64-darwin)
       racc (~> 1.4)
     oauth (1.1.0)
@@ -151,9 +148,6 @@ GEM
     parallel (1.23.0)
     parser (3.2.2.1)
       ast (~> 2.4.1)
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     racc (1.6.2)
     rack (2.2.7)
     rack-test (2.1.0)

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/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/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.1"
+  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/rails/initializer/schoology-client.rb.tt

@@ -1,5 +0,0 @@
-SchoologyClient.configure |config|
-    config.consumer_key = ENV['SCHOOLOGY_CONSUMER_KEY']
-    config.consumer_secret = ENV['SCHOOLOGY_CONSUMER_SECRET']
-    config.url = ENV['SCHOOLOGY_URL']
-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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-schoology-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Strongmind
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.x
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.x
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.x
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 7.x
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 description: 
 email:
 - qwertytalk@strongmind.com
@@ -96,15 +96,18 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- lib/schoology-client.rb
-- lib/schoology-client/client.rb
-- lib/schoology-client/error.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,47 +0,0 @@
-# frozen_string_literal: true
-require 'faraday'
-require 'faraday_middleware'
-require 'oauth'
-
-module SchoologyClient
-  class Client
-    BASE_URL = "https://api.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
-      consumer_key = "2c40b07185fbd031567affed01fcff630644fee80"
-      consumer_secret = "fd5863739d9f50922aa4f1cb9f4a4908"
-
-      # Set up the OAuth 1.0 consumer
-      consumer = OAuth::Consumer.new(
-        consumer_key,
-        consumer_secret,
-        site: BASE_URL,
-        scheme: :header,
-        signature_method: 'PLAINTEXT',
-        realm: 'Schoology API'
-      )
-
-      # Set up the Faraday connection
-      # Set up the Faraday connection
-      connection = Faraday.new(BASE_URL) do |conn|
-        conn.request :url_encoded
-        conn.response :json
-        conn.adapter Faraday.default_adapter
-      end
-    end
-  end
-end
-

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

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-require 'pry'
-
-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,27 +0,0 @@
-# frozen_string_literal: true
-
-require "faraday"
-require "faraday_middleware"
-require "rails/all"
-require_relative "schoology-client/version"
-
-module SchoologyClient
-  autoload :Client, "schoology-client/client"
-  autoload :Object, "schoology-client/object"
-  autoload :Resource, "schoology-client/resource"
-  autoload :Error, "schoology-client/error"
-
-  # 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"
-
-  class Railtie < Rails::Railtie
-    initializer 'schoology-client.insert_into_initializer' do
-      config_path = Rails.root.join('config/initializers/schoology-client.rb')
-      template_path = File.expand_path('../../templates/rails/initializer/schoology-client.rb.tt', __FILE__)
-      File.write(config_path, ERB.new(File.read(template_path)).result)
-    end
-  end
-end