simple_twitter_oauth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 664435a3eff5683bf4db78ca51f1d676eb1252c1
+  data.tar.gz: c21379f64972f61df86a76d96ebe4bd390ecfdec
+SHA512:
+  metadata.gz: 5df6717a828fcf742e5a5c63a2c6d698de3ac6def5cb2eb6692bed19f84674b457fe65c9d07d7951d9c0ca0c8d7c7d5f71b6a33c6aa2ae5431315ca0432bf900
+  data.tar.gz: 3358772aef5c4f70c5c53a74b3515165e9796c558c6ab932aad23db0e17781a0b32ce54042dc801cb2505509ee013d4fb77c9908fc674518a472a2de43df39e0

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/pkg/

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at odindutton@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Odin Dutton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Simple Twitter OAuth
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'simple_twitter_oauth'
+```
+
+## Usage
+
+``` ruby
+request_token = SimpleTwitterOAuth.get_request_token(
+  consumer_key: 'abc123',
+  consumer_secret: 'def456',
+  callback_url: 'https://example.com/callback',
+)
+
+session[:token] = request_token.token
+session[:token_secret] = request_token.secret
+
+redirect_to request_token.authorize_url
+```
+
+``` ruby
+access_token = SimpleTwitterOAuth.get_access_token(
+  consumer_key: 'abc123',
+  consumer_secret: 'def456',
+  token: session.delete(:token),
+  token_secret: session.delete(:token_secret),
+  oauth_verifier: params[:oauth_verifier],
+)
+
+if access_token
+  # These are the methods available on AccessToken:
+  #
+  #     access_token.screen_name
+  #     access_token.token
+  #     access_token.secret
+
+  redirect_to account_path, success: 'Account added successfully'
+else
+  redirect_to account_path, alert: 'Adding account failed'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`,
+which will create a git tag for the version,
+push git commits and tags,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/twe4ked/simple_twitter_oauth This project is intended to be a safe,
+welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec do |task|
+  task.verbose = false
+end
+
+task default: :spec

data/lib/simple_twitter_oauth/access_token.rb

@@ -0,0 +1,13 @@
+module SimpleTwitterOAuth
+  class AccessToken
+    attr_reader :screen_name, :token, :secret
+
+    # @api private
+    def initialize(screen_name:, token:, secret:)
+      @screen_name = screen_name
+      @token = token
+      @secret = secret
+      freeze
+    end
+  end
+end

data/lib/simple_twitter_oauth/request_token.rb

@@ -0,0 +1,13 @@
+module SimpleTwitterOAuth
+  class RequestToken
+    attr_reader :token, :secret, :authorize_url
+
+    # @api private
+    def initialize(token:, secret:, authorize_url:)
+      @token = token
+      @secret = secret
+      @authorize_url = authorize_url
+      freeze
+    end
+  end
+end

data/lib/simple_twitter_oauth/version.rb

@@ -0,0 +1,3 @@
+module SimpleTwitterOAuth
+  VERSION = '1.0.0'
+end

data/lib/simple_twitter_oauth.rb

@@ -0,0 +1,53 @@
+require 'simple_twitter_oauth/version'
+require 'simple_twitter_oauth/request_token'
+require 'simple_twitter_oauth/access_token'
+
+require 'oauth'
+
+module SimpleTwitterOAuth
+  SITE = 'https://twitter.com'
+
+  # This method is used to before sending the user to Twitter for authentication.
+  #
+  # @param consumer_key [String] the Twitter application's consumer key
+  # @param consumer_secret [String] the Twitter application's consumer secret
+  # @param callback_url [String] the URL that Twitter will call after the user has authenticated
+  # @return [SimpleTwitterOAuth::RequestToken] an object with a token, secret, and authorize_url
+  def self.get_request_token(consumer_key:, consumer_secret:, callback_url:)
+    consumer = OAuth::Consumer.new(consumer_key, consumer_secret, site: SITE)
+    request_token = consumer.get_request_token(oauth_callback: callback_url)
+
+    RequestToken.new(
+      token: request_token.token,
+      secret: request_token.secret,
+      authorize_url: request_token.authorize_url(oauth_callback: callback_url),
+    )
+  end
+
+  # This method is used after the user has authenticated with Twitter.
+  #
+  # @param consumer_key [String] the Twitter application's consumer key
+  # @param consumer_secret [String] the Twitter application's consumer secret
+  # @param token [String] the token returned from get_request_token
+  # @param token_secret [String] the secret returned from get_request_token
+  # @param oauth_verifier [String] the oauth_verifier param from the callback URL
+  # @return [SimpleTwitterOAuth::AccessToken, nil] an object with a screen_name, token, and secret, or nil
+  def self.get_access_token(consumer_key:, consumer_secret:, token:, token_secret:, oauth_verifier:)
+    consumer = OAuth::Consumer.new(consumer_key, consumer_secret, site: SITE)
+    request_token = OAuth::RequestToken.from_hash(consumer,
+      oauth_token: token,
+      oauth_token_secret: token_secret,
+    )
+
+    begin
+      access_token = request_token.get_access_token(oauth_verifier: oauth_verifier)
+
+      AccessToken.new(
+        screen_name: access_token.params[:screen_name],
+        token: access_token.token,
+        secret: access_token.secret,
+      )
+    rescue OAuth::Unauthorized
+    end
+  end
+end

data/simple_twitter_oauth.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'simple_twitter_oauth/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'simple_twitter_oauth'
+  spec.version = SimpleTwitterOAuth::VERSION
+  spec.authors = ['Odin Dutton']
+  spec.email = ['odindutton@gmail.com']
+  spec.summary = 'A really simple Twitter OAuth library.'
+  spec.homepage = 'https://github.com/twe4ked/simple_twitter_oauth'
+  spec.license = 'MIT'
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'oauth', '~> 0.5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: simple_twitter_oauth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Odin Dutton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- odindutton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_twitter_oauth.rb
+- lib/simple_twitter_oauth/access_token.rb
+- lib/simple_twitter_oauth/request_token.rb
+- lib/simple_twitter_oauth/version.rb
+- simple_twitter_oauth.gemspec
+homepage: https://github.com/twe4ked/simple_twitter_oauth
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A really simple Twitter OAuth library.
+test_files: []