platforms-yammer 0.1.0

data/lib/platforms/yammer/configuration.rb

@@ -0,0 +1,76 @@
+module Platforms
+  module Yammer
+
+    # Configuration pattern for Rails, allows defaults and initializers to
+    # override those defaults.
+    # @see https://stackoverflow.com/a/24151439 Stack Overflow
+    class << self
+
+      # Get the configuration
+      # @return [Configuration] the current configuration
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # Used by initializers to set the configuration
+      # @yieldparam configuration [Configuration] the object to configure
+      def configure
+        yield configuration
+      end
+    end
+
+    # The class which stores the gem's configuration
+    # Should only store Yammer configuration options, other configuration
+    # options should be made in core.
+    #
+    # @author Benjamin Elias
+    # @since 0.1.0
+    class Configuration
+      include ActiveSupport::Configurable
+
+      ##
+      # The default client_id, if no saved {Platforms::Certificate} exists.
+      # A saved Certificate will be used in preference to this default.
+      # @return [String] the default client_id
+      config_accessor(:client_id, instance_reader: false)
+
+      def client_id
+        if config[:client_id].blank?
+          raise "Please configure Client ID as a non-empty value"
+        elsif config[:client_id] == 'your_client_id'
+          raise "Please configure Client ID as a real value, not 'your_client_id'"
+        end
+        config[:client_id]
+      end
+
+      ##
+      # The default client_secret, if no saved {Platforms::Certificate} exists.
+      # A saved Certificate will be used in preference to this default.
+      # @return [String] the default client_secret
+      config_accessor(:client_secret, instance_reader: false)
+
+      def client_secret
+        if config[:client_secret].blank?
+          raise "Please configure Client Secret as a non-empty value"
+        elsif config[:client_secret] == 'your_client_secret'
+          raise "Please configure Client Secret as a real value, not 'your_client_secret'"
+        end
+        config[:client_secret]
+      end
+
+      ## 
+      # The base Yammer URL for API requests. Defaults to
+      # https://www.yammer.com/api/v1
+      # @return [String] the base Yammer URL
+      config_accessor(:api_base, instance_reader: false) do
+        'https://www.yammer.com/api/v1'
+      end
+
+      def api_base
+        URI.parse config[:api_base]
+        config[:api_base]
+      end
+
+    end
+  end
+end

data/lib/platforms/yammer/engine.rb

@@ -0,0 +1,27 @@
+module Platforms
+  module Yammer
+
+    # Isolated Rails Engine
+    # @see https://guides.rubyonrails.org/engines.html
+    #
+    # @author Benjamin Elias
+    # @since 0.1.0
+    class Engine < ::Rails::Engine
+
+      # Isolate namespace, as generally required for gems
+      isolate_namespace Platforms::Yammer
+
+      # Use RSpec and FactoryBot
+      config.generators do |g|
+        g.test_framework :rspec
+        g.fixture_replacement :factory_bot
+        g.factory_bot dir: 'spec/factories'
+      end
+
+      # Set factory paths for FactoryBot
+      initializer "platforms.factories", :after => "factory_bot.set_factory_paths" do
+        FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryBot)
+      end
+    end
+  end
+end

data/lib/platforms/yammer/omni_auth_setup.rb

@@ -0,0 +1,31 @@
+require 'platforms/core'
+require 'platforms/yammer/configuration'
+
+module Platforms
+  module Yammer
+
+    # Yammer-specific requirements for OmniAuth setup.
+    # Sets the default certificate to the {Configuration} values.
+    # Setting Client ID and Client Secret are done in Platforms::Core:OmniAuthSetup
+    #
+    # @author Benjamin Elias
+    # @since 0.1.0
+    # @see https://www.createdbypete.com/dynamic-omniauth-provider-setup/ Dynamic providers.
+    # @see https://github.com/omniauth/omniauth/wiki/Setup-Phase OmniAuth Setup Phase
+    class OmniAuthSetup < ::Platforms::Core::OmniAuthSetup
+
+      # Create a Certificate with the default configuration setup
+      # according to the {Configuration} for client_id and client_secret,
+      # usually specified in the gem's initializer.
+      # This can be used if there is no Certificate saved in the database.
+      # @return [Platforms::Certificate] the Certificate to use by default
+      def default_certificate
+        Certificate.new do |c|
+          c.client_id =     Platforms::Yammer.configuration.client_id
+          c.client_secret = Platforms::Yammer.configuration.client_secret
+        end
+      end
+
+    end
+  end
+end

data/lib/platforms/yammer/railtie.rb

@@ -0,0 +1,19 @@
+require 'omniauth'
+require 'omniauth-yammer'
+require 'platforms/yammer/omni_auth_setup'
+
+module Platforms
+  module Yammer
+
+    # Railtie to configure OmniAuth with {OmniAuthSetup}
+    # @author Benjamin Elias
+    # @since 0.1.0
+    class Railtie < ::Rails::Railtie
+      initializer "configure OmniAuth for Yammer" do |app|
+        app.config.middleware.use ::OmniAuth::Builder do
+          provider :yammer, setup: OmniAuthSetup
+        end
+      end
+    end
+  end
+end

data/lib/platforms/yammer/version.rb

@@ -0,0 +1,7 @@
+module Platforms
+  module Yammer
+    # Current version
+    # Use semantic versioning (major.minor.patch)
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/platforms/yammer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :platforms_yammer do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: platforms-yammer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin Elias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: platforms-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-yammer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Authentication with OmniAuth, API integration
+email:
+- 12136262+collabital@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/platforms/yammer/install/USAGE
+- lib/generators/platforms/yammer/install/install_generator.rb
+- lib/generators/platforms/yammer/install/templates/platforms_yammer.rb
+- lib/platforms/yammer.rb
+- lib/platforms/yammer/api.rb
+- lib/platforms/yammer/api/base.rb
+- lib/platforms/yammer/api/group_memberships.rb
+- lib/platforms/yammer/api/groups.rb
+- lib/platforms/yammer/api/invitations.rb
+- lib/platforms/yammer/api/messages.rb
+- lib/platforms/yammer/api/networks.rb
+- lib/platforms/yammer/api/oauth.rb
+- lib/platforms/yammer/api/open_graph_objects.rb
+- lib/platforms/yammer/api/pending_attachments.rb
+- lib/platforms/yammer/api/relationships.rb
+- lib/platforms/yammer/api/search.rb
+- lib/platforms/yammer/api/streams.rb
+- lib/platforms/yammer/api/subscriptions.rb
+- lib/platforms/yammer/api/suggestions.rb
+- lib/platforms/yammer/api/supervisor_mode.rb
+- lib/platforms/yammer/api/threads.rb
+- lib/platforms/yammer/api/topics.rb
+- lib/platforms/yammer/api/uploaded_files.rb
+- lib/platforms/yammer/api/users.rb
+- lib/platforms/yammer/authentication.rb
+- lib/platforms/yammer/client.rb
+- lib/platforms/yammer/configuration.rb
+- lib/platforms/yammer/engine.rb
+- lib/platforms/yammer/omni_auth_setup.rb
+- lib/platforms/yammer/railtie.rb
+- lib/platforms/yammer/version.rb
+- lib/tasks/platforms/yammer_tasks.rake
+homepage: https://www.collabital.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Authentication and API integration with Yammer
+test_files: []