slack-api-wrapper 0.0.6 → 0.1.0

data/slack-api-wrapper.gemspec

@@ -4,25 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'slack/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "slack-api-wrapper"
+  spec.name          = 'slack-api-wrapper'
   spec.version       = Slack::VERSION
-  spec.authors       = ["Gustavo Bazan"]
-  spec.email         = ["contacto@gustavobazan.com"]
-  spec.summary       = "Slack API Wrapper"
+  spec.authors       = ['Gustavo Bazan']
+  spec.email         = ['contacto@gustavobazan.com']
+  spec.summary       = 'Slack API Wrapper'
   spec.description   = <<-EOF
         A library that provides a plain function-call interface to the
         Slack API web endpoints.
     EOF
-  spec.homepage      = "https://github.com/gssbzn/slack-api-wrapper"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/gssbzn/slack-api-wrapper'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", '~> 0'
-  spec.add_development_dependency "rspec", '~> 3.2', '>= 3.2.0'
-  spec.add_development_dependency "yard", '~> 0.8.7', '>= 0.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency 'webmock', '~> 1.21', '>= 1.21.0'
+  spec.add_development_dependency 'coveralls', '~>0.8.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7', '>= 0.8.0'
 end

data/spec/slack/client_spec.rb

@@ -2,11 +2,10 @@ require 'spec_helper'
 
 describe Slack::Client do
   it 'Initialize' do
-    client = Slack::Client.new("")
+    client = Slack::Client.new('')
     expect(client).not_to be nil
   end
   it 'Validates token is string' do
-    expect{Slack::Client.new(1)}.to raise_error(ArgumentError)
+    expect { Slack::Client.new(1) }.to raise_error(ArgumentError)
   end
-  
 end

data/spec/slack/session_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Slack::Session do
+  it 'Initialize' do
+    session = Slack::Session.new('')
+    expect(session).not_to be nil
+  end
+  it 'Validates token is string' do
+    expect { Slack::Session.new(1) }.to raise_error(ArgumentError)
+  end
+
+  describe "instance methods" do
+    subject(:session) { Slack::Session.new('') }
+    describe '#make_query_string' do
+      let(:params) { { 'test_1' => 'test', 'test_2' => 'test' } }
+      it 'transform params to query string' do
+        expect(session.make_query_string(params)).to eq('test_1=test&test_2=test')
+      end
+    end
+  end
+end

data/spec/slack_spec.rb

@@ -8,23 +8,4 @@ describe Slack do
   it 'has web server domain' do
     expect(Slack::WEB_SERVER).to eq('slack.com')
   end
-
-  it 'has api uri' do
-    expect(Slack::API_SERVER).to eq('slack.com/api')
-  end
-
-  describe '::clean_params' do
-    let(:params){ {"test_1"=>"test", "test_2" => nil} }
-    it 'removes nil params' do
-      expect(Slack::clean_params(params)).to eq({"test_1"=>"test"})
-    end
-  end
-  
-  describe '::make_query_string' do
-    let(:params){ {"test_1"=>"test", "test_2" => "test"} }
-    it 'transform params to query string' do
-      expect(Slack::make_query_string(params)).to eq("test_1=test&test_2=test")
-    end
-  end
-
 end

data/spec/spec_helper.rb

@@ -1,3 +1,83 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec/support'
+end
 
 require 'slack-api-wrapper'
+
+require 'bundler/setup'
+require 'webmock/rspec'
+Bundler.require
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  # config.filter_run :focus
+  # config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  # config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  # if config.files_to_run.one?
+  #   Use the documentation formatter for detailed output,
+  #   unless a formatter has already been configured
+  #   (e.g. via a command-line flag).
+  #   config.default_formatter = 'doc'
+  # end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-api-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Gustavo Bazan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-16 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -87,19 +121,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".simplecov"
 - ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/slack-api-wrapper.rb
 - lib/slack/client.rb
 - lib/slack/error.rb
-- lib/slack/oauth2.rb
-- lib/slack/oauth2/flow.rb
-- lib/slack/oauth2/flow_base.rb
+- lib/slack/request.rb
 - lib/slack/session.rb
 - lib/slack/version.rb
 - lib/slack/web.rb
@@ -111,15 +149,15 @@ files:
 - lib/slack/web/files.rb
 - lib/slack/web/groups.rb
 - lib/slack/web/im.rb
+- lib/slack/web/pins.rb
+- lib/slack/web/reactions.rb
 - lib/slack/web/search.rb
 - lib/slack/web/stars.rb
 - lib/slack/web/team.rb
 - lib/slack/web/users.rb
 - slack-api-wrapper.gemspec
 - spec/slack/client_spec.rb
-- spec/slack/oauth2/flow_base_spec.rb
-- spec/slack/oauth2/flow_spec.rb
-- spec/slack/oauth2_spec.rb
+- spec/slack/session_spec.rb
 - spec/slack_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gssbzn/slack-api-wrapper
@@ -148,9 +186,7 @@ specification_version: 4
 summary: Slack API Wrapper
 test_files:
 - spec/slack/client_spec.rb
-- spec/slack/oauth2/flow_base_spec.rb
-- spec/slack/oauth2/flow_spec.rb
-- spec/slack/oauth2_spec.rb
+- spec/slack/session_spec.rb
 - spec/slack_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/slack/oauth2.rb

@@ -1,10 +0,0 @@
-# Copyright (c) 2015 Gustavo Bazan
-# MIT License
-
-require_relative 'oauth2/flow_base'
-require_relative 'oauth2/flow'
-module Slack
-  # Oauth2 authentication
-  module Oauth2
-  end
-end

data/lib/slack/oauth2/flow.rb

@@ -1,165 +0,0 @@
-# Copyright (c) 2015 Gustavo Bazan
-# MIT License
-
-require 'securerandom'
-
-require_relative 'flow_base'
-
-module Slack
-  module Oauth2
-    # The standard OAuth 2 authorization helper.
-    class Flow < FlowBase
-
-      # @param [String] consumer_key
-      #   Your Slack API app's "app key"
-      # @param [String] consumer_secret
-      #   Your Slack API app's "app secret"
-      # @param [String] redirect_uri
-      #   The URI that the Slack server will redirect the user to after the user
-      #   finishes authorizing your app.  This URI  must be HTTPs-based and pre-registered with
-      #   the Slack servers.
-      # @param [Hash] session
-      #   represents the current web app session (will be used to save the CSRF token)
-      # @param [Object] csrf_token_key
-      #   The key to use when storing the CSRF token in the session (for example,
-      #   :slack_auth_csrf_token)
-      def initialize(consumer_key, consumer_secret, redirect_uri, scope, team, session, csrf_token_session_key)
-        super(consumer_key, consumer_secret, scope, team)
-        unless redirect_uri.is_a?(String)
-          raise ArgumentError, "redirect_uri must be a String, got #{consumer_secret.inspect}"
-        end
-        @redirect_uri = redirect_uri
-        @session = session
-        @csrf_token_session_key = csrf_token_session_key
-      end
-
-      # Starts the OAuth 2 authorizaton process, which involves redirecting the user to
-      # the returned "authorization URL" (a URL on the Slack website).  When the user then
-      # either approves or denies your app access, Slack will redirect them to the
-      # redirect_uri you provided to the constructor, at which point you should call finish()
-      # to complete the process.
-      #
-      # This function will also save a CSRF token to the session and csrf_token_session_key
-      # you provided to the constructor.  This CSRF token will be checked on finish() to prevent
-      # request forgery.
-      #
-      # @param [String] url_state
-      #   Any data you would like to keep in the URL through the authorization
-      #   process.  This exact value will be returned to you by finish().
-      #
-      # @return Returns the URL to redirect the user to.
-      def start(url_state=nil)
-        unless url_state.nil? or url_state.is_a?(String)
-          raise ArgumentError, "url_state must be a String"
-        end
-
-        csrf_token = SecureRandom.base64(16)
-        state = csrf_token
-        unless url_state.nil?
-            state += "|" + url_state
-        end
-        @session[@csrf_token_session_key] = csrf_token
-        _get_authorize_url(@redirect_uri, state)
-      end
-
-      # Call this after the user has visited the authorize URL (see: start()), approved your app,
-      # and was redirected to your redirect URI.
-      #
-      # @param [Hash] query_params
-      #   The query params on the GET request to your redirect URI.
-      #
-      # @return Returns a tuple of (access_token, scope, url_state).  access_token can be used to
-      #   construct a SlackClient.  scpe is the Slack scope the user that jsut approved
-      #   your app.  url_state is the value you originally passed in to start().
-      #
-      # @raise [BadRequestError]
-      # @raise [BadStateError]
-      # @raise [CsrfError]
-      # @raise [NotApprovedError]
-      # @raise [ProviderError]
-      def finish(query_params)
-        csrf_token_from_session = @session[@csrf_token_session_key]
-
-        # Check well-formedness of request.
-
-        state = query_params['state']
-        if state.nil?
-          raise BadRequestError.new("Missing query parameter 'state'.")
-        end
-        code = query_params['code']
-
-        error = query_params['error']
-
-        unless error.nil? || code.nil?
-          raise BadRequestError.new("Query parameters 'code' and 'error' are both set;" +
-          " only one must be set.")
-        end
-        if error.nil? && code.nil?
-          raise BadRequestError.new("Neither query parameter 'code' or 'error' is set.")
-        end
-
-        # Check CSRF token
-
-        if csrf_token_from_session.nil?
-          raise BadStateError.new("Missing CSRF token in session.");
-        end
-        unless csrf_token_from_session.length > 20
-          raise RuntimeError.new("CSRF token unexpectedly short: #{csrf_token_from_session.inspect}")
-        end
-
-        split_pos = state.index('|')
-        if split_pos.nil?
-          given_csrf_token = state
-          url_state = nil
-        else
-          given_csrf_token, url_state = state.split('|', 2)
-        end
-        unless Slack::safe_string_equals(csrf_token_from_session, given_csrf_token)
-          raise CsrfError.new("Expected #{csrf_token_from_session.inspect}, " +
-                              "got #{given_csrf_token.inspect}.")
-        end
-        @session.delete(@csrf_token_session_key)
-
-        # Check for error identifier
-
-        unless error.nil?
-          if error == 'access_denied'
-            # The user clicked "Deny"
-            raise NotApprovedError.new("No additional description from Slack.")
-          else
-            raise ProviderError.new(error)
-          end
-        end
-
-        # If everything went ok, make the network call to get an access token.
-
-        access_token, scope = _finish(code, @redirect_uri)
-        return access_token, scope, url_state
-      end
-
-      # Thrown if the redirect URL was missing parameters or if the given parameters were not valid.
-      #
-      # The recommended action is to show an HTTP 400 error page.
-      class BadRequestError < Exception; end
-
-      # Thrown if all the parameters are correct, but there's no CSRF token in the session.  This
-      # probably means that the session expired.
-      #
-      # The recommended action is to redirect the user's browser to try the approval process again.
-      class BadStateError < Exception; end
-
-      # The user chose not to approve your app.
-      class NotApprovedError < Exception; end
-
-      # Thrown if the given 'state' parameter doesn't contain the CSRF token from the user's session.
-      # This is blocked to prevent CSRF attacks.
-      #
-      # The recommended action is to respond with an HTTP 403 error page.
-      class CsrfError < Exception; end
-
-      # Slack redirected to your redirect URI with some unexpected error identifier and error
-      # message.
-      class ProviderError < Exception; end
-    end
-  end
-end