simple_twitter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2736729c95b2f5def88674bda64a6fecd397a5f422c829ab8b301ac4a36f216c
+  data.tar.gz: 530c600f14041e91c7476b1179bf2069f8d35076175d10089b07db642b13c3fe
+SHA512:
+  metadata.gz: e216e514b9bcdfd91e600e07137c409b1bd3d84c4eb045a7988b30a29c4b4dea4bb05f39dddf309295c104a640420bd43a7cf5f7f2702b86ea05f13b2df0acda
+  data.tar.gz: '036388ae7887f3af5b3b625f15dd6ab7e5241502e1af4257ae1b59ed92b3082e406f9246f623d711a9791af9de851d3f0b5870badde6a4e41e4673df75308a06'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v1.0.0 (2021-03-28)
+
+- initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_twitter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yutaka HARA
+
+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,93 @@
+# simple_twitter
+
+Dead simple Twitter API client. Supports both v1 and v2
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_twitter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_twitter
+
+## Example
+
+```rb
+require 'simple_twitter'
+
+client = SimpleTwitter::Client.new(bearer_token: "...")
+pp client.get("https://api.twitter.com/2/tweets",
+              ids: "1302127884039909376,1369885448319889409")
+```
+
+Result:
+
+```
+{:data=>
+  [{:id=>"1302127884039909376",
+    :text=>
+     "We conclude RubyKaigi Takeout 2020. We hope we can meet in-person, safely at RubyKaigi 2021 in Mie! Thank you all for tuning in. #rubykaigi"},
+   {:id=>"1369885448319889409",
+    :text=>
+     "RubyKaigi 2021 is going online again: RubyKaigi Takeout 2021 will happen this fall. https://t.co/Fv1PlvmUHh"}]}
+```
+
+As you see hash keys are converted into symbols (Note that strings as values are not converted.)
+
+### Call API on user context 
+
+Some operations (eg. posting a tweet) needs OAuth instead of `bearer_token`.
+
+```rb
+config = (load from yaml or something)
+client = SimpleTwitter::Client.new(
+  api_key: config[:api_key],
+  api_secret_key: config[:api_secret_key],
+  access_token: config[:access_token],
+  access_token_secret: config[:access_token_secret],
+)
+pp client.post("https://api.twitter.com/1.1/statuses/update.json",
+               status: "Test.")
+```
+
+You can get the access_token and access_token_secret for your own at the Twitter Developer Portal. For other users, you need to get them via OAuth (out of scope of this gem.)
+
+### Advanced
+
+If you want the raw json string or use streaming API, use `get_raw`, `post_raw`, etc. which returns `HTTP::Response` of the [http gem](https://github.com/httprb/http).
+
+```rb
+res = client.get_raw("https://api.twitter.com/2/tweets/sample/stream")
+p res #=> #<HTTP::Response ...>
+loop do
+  puts res.body.readpartial
+end
+```
+
+### Hint
+
+Some API parameters has `.` in its name (eg. `tweet.fields`.) Did you know that in Ruby you can include `.` in a hash key if quoted? :-)
+
+```rb
+tweets = @client.get("https://api.twitter.com/2/users/#{id}/tweets", {
+  expansions: "author_id",
+  max_results: 100,
+  "tweet.fields": "author_id,created_at,referenced_tweets,text",
+})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/naclyhara/simple_twitter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "simple_twitter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_twitter.rb

@@ -0,0 +1,59 @@
+require 'http'
+require 'simple_oauth'
+
+module SimpleTwitter
+  class Client
+    def initialize(bearer_token: nil,
+                   api_key: nil,
+                   api_secret_key: nil,
+                   access_token: nil,
+                   access_token_secret: nil)
+      if bearer_token
+        @bearer_token = bearer_token
+      else
+        @oauth_params = {
+          consumer_key: api_key,
+          consumer_secret: api_secret_key,
+          token: access_token,
+          token_secret: access_token_secret,
+        }
+      end
+    end
+
+    %i[get post put delete].each do |m|
+      class_eval <<~EOD
+        # @return [Object] parsed json data
+        def #{m}(url, params={})
+          JSON.parse(#{m}_raw(url, params).to_s, symbolize_names: true)
+        end
+
+        # @return [HTTP::Response]
+        def #{m}_raw(url, params={})
+          http(:#{m}, url, params).#{m}(url, params: params)
+        end
+      EOD
+    end
+
+    private
+
+    # @param method [Symbol]
+    # @param url [String]
+    # @param params [Hash<Symbol, String>]
+    # @return [HTTP::Request]
+    def http(method, url, params)
+      HTTP.auth(auth_header(method, url, params))
+    end
+
+    # @param method [Symbol]
+    # @param url [String]
+    # @param params [Hash<Symbol, String>]
+    # @return [String]
+    def auth_header(method, url, params)
+      if @bearer_token
+        "Bearer #{@bearer_token}"
+      else
+        SimpleOAuth::Header.new(method, url, params, @oauth_params).to_s
+      end
+    end
+  end
+end

data/lib/simple_twitter/version.rb

@@ -0,0 +1,3 @@
+module SimpleTwitter
+  VERSION = "1.0.0"
+end

data/simple_twitter.gemspec

@@ -0,0 +1,30 @@
+require_relative "lib/simple_twitter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_twitter"
+  spec.version       = SimpleTwitter::VERSION
+  spec.authors       = ["Yutaka HARA"]
+  spec.email         = ["yutaka.hara+github@gmail.com"]
+
+  spec.summary       = "Dead simple client for Twitter API v1/v2"
+  spec.description   = "Dead simple client for Twitter API (supports both v1 and v2)"
+  spec.homepage      = "https://github.com/yhara/simple_twitter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", "~> 4"
+  spec.add_dependency "simple_oauth", "~> 0.3.1"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: simple_twitter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yutaka HARA
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: Dead simple client for Twitter API (supports both v1 and v2)
+email:
+- yutaka.hara+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_twitter.rb
+- lib/simple_twitter/version.rb
+- simple_twitter.gemspec
+homepage: https://github.com/yhara/simple_twitter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yhara/simple_twitter
+  source_code_uri: https://github.com/yhara/simple_twitter
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Dead simple client for Twitter API v1/v2
+test_files: []