tweetkit 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9fe5ece4cef00bc50ac604a61d38321fb9aeeef648f6586696d0c1b1e14391c
+  data.tar.gz: bafdeeda01397333a669aa4dc5eb9021b3c934995a82b1116de74e5f8a7202f9
+SHA512:
+  metadata.gz: e832b0ac7583b4604eca6db1a79615ea86d984191cdd03efcae7fa44215b5a8d1bd78b760312d7e544c595f6c24843983b54e87b4d8f58dfee6e4fa828ea6f9f
+  data.tar.gz: '045117388ada745f039095a51a0e59583509d984eb8bdab308366b14e27dc8908a5849d7f5da436c480ea1fd1b415e87201ee0174298d6ce2f150f4bc7925bd8'

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tweetkit.gemspec
+gemspec
+
+gem 'faraday'
+gem 'faraday_middleware'
+gem "minitest", "~> 5.0"
+gem "rake", "~> 12.0"
+gem 'simple_oauth', "~> 0.3.0"
+
+group :test, :development do
+  gem 'pry', '~> 0.13.1'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    tweetkit (0.1.0)
+      faraday (>= 0.9)
+      faraday_middleware (~> 1.0.0)
+      simple_oauth (~> 0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.1.0)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    multipart-post (2.1.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    ruby2_keywords (0.0.4)
+    simple_oauth (0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday
+  faraday_middleware
+  minitest (~> 5.0)
+  pry (~> 0.13.1)
+  rake (~> 12.0)
+  simple_oauth (~> 0.3.0)
+  tweetkit!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,69 @@
+# Tweetkit
+
+`Tweetkit` is a Ruby wrapper for [Twitter's V2 API](https://developer.twitter.com/en/docs/twitter-api/early-access).
+
+`Tweetkit` is inspired by the original [Twitter gem](https://github.com/sferik/twitter) and the [Octokit ecosystem](https://github.com/octokit/octokit.rb).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tweetkit'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install tweetkit
+
+## Usage
+
+1. Require the gem.
+
+```ruby
+  require 'tweetkit'
+```
+
+2. Initialize a `Tweetkit::Client` instance by passing in your `Bearer Token` to work with Twitter's `OAuth 2.0` authorization requirement. You should also pass in your consumer key and token to perform requests that require `OAuth 1.0` authorization. 
+
+[Read more on how to apply and access your Twitter tokens here.](https://developer.twitter.com/en/docs/twitter-api/getting-started/getting-access-to-the-twitter-api)
+
+```ruby
+  # Initializing via options
+  client = Tweetkit::Client.new(bearer_token: 'YOUR_BEARER_TOKEN_HERE')
+
+  # Initializing via options with OAuth 1.0 credentials
+  client = Tweetkit::Client.new(bearer_token: 'YOUR_BEARER_TOKEN_HERE', consumer_key: 'YOUR_API_KEY_HERE', consumer_token: 'YOUR_API_TOKEN_HERE')
+
+  # You can also initialize the client with a block
+  client = Tweetkit::Client.new do |config|
+    config.bearer_token = 'YOUR_BEARER_TOKEN_HERE'
+    config.consumer_key = 'YOUR_API_KEY_HERE'
+    config.consumer_token = 'YOUR_API_TOKEN_HERE'
+  end
+```
+
+3. Interact with the Twitter API as needed. Below is an example of fetching a tweet with id `1234567890`.
+
+```ruby
+  response = client.tweet(1234567890)
+```
+
+## Documentation
+
+Coming soon.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/julianfssen/tweetkit.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tweetkit"
+
+# 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/tweetkit.rb

@@ -0,0 +1,11 @@
+require 'tweetkit/client'
+
+module Tweetkit
+  class << self
+    def client
+      return @client if defined?(@client) && @client.same_options?(options)
+
+      @client = Tweetkit::Client.new(options)
+    end
+  end
+end

data/lib/tweetkit/auth.rb

@@ -0,0 +1,15 @@
+module Tweetkit
+  module Auth
+    def basic_auth?
+      !!(@login && @password)
+    end
+
+    def token_auth?
+      !!(@access_token && @access_token_secret)
+    end
+
+    def bearer_auth?
+      !!@bearer_token
+    end
+  end
+end

data/lib/tweetkit/client.rb

@@ -0,0 +1,19 @@
+require 'tweetkit/configurable'
+require 'tweetkit/connection'
+require 'tweetkit/client/tweets'
+
+module Tweetkit
+  class Client
+    include Tweetkit::Connection
+    include Tweetkit::Client::Tweets
+
+    attr_accessor :access_token, :access_token_secret, :bearer_token, :consumer_key, :consumer_secret, :email, :password
+
+    def initialize(options = {})
+      options.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+      yield self if block_given?
+    end
+  end
+end

data/lib/tweetkit/client/tweets.rb

@@ -0,0 +1,26 @@
+require 'tweetkit/search'
+
+module Tweetkit
+  class Client
+    module Tweets
+      def tweet(id, **options)
+        get "tweets/#{id}", options
+      end
+
+      def tweets(ids, **options)
+        if ids.is_a? Array
+          ids = ids.join(',')
+        else
+          ids = ids.delete(' ')
+        end
+        get 'tweets', options.merge!({ ids: ids })
+      end
+
+      def search(query = '', type: :tweet, **options, &block)
+        search = Search.new(query)
+        search.setup(&block) if block_given?
+        get 'tweets/search/recent', options.merge!({ query: search.combined_query })
+      end
+    end
+  end
+end

data/lib/tweetkit/configurable.rb

@@ -0,0 +1,21 @@
+module Tweetkit
+  module Configurable
+    def self.keys
+      @keys ||= %i[
+        access_token
+        access_token_secret
+        bearer_token
+        consumer_key
+        consumer_secret
+        password
+        email
+      ]
+    end
+
+    private
+
+    def options
+      Hash[Tweetkit::Configurable.keys.map { |key| [key, instance_variable_get(:"@#{key}")] }]
+    end
+  end
+end

data/lib/tweetkit/connection.rb

@@ -0,0 +1,96 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'tweetkit/auth'
+require 'tweetkit/default'
+require 'tweetkit/response'
+
+module Tweetkit
+  module Connection
+    include Tweetkit::Auth
+
+    BASE_URL = 'https://api.twitter.com/2/'
+
+    def get(endpoint, **options)
+      request :get, endpoint, parse_query_and_convenience_headers(options)
+    end
+
+    def request(method, endpoint, data, **options)
+      auth_type = options.delete(:auth_type)
+      url = URI.parse("#{BASE_URL}#{endpoint}")
+
+      if method == :get
+        conn = Faraday.new(params: data) do |c|
+          if auth_type == 'oauth1'
+            c.request :oauth, consumer_key: @consumer_key, consumer_secret: @consumer_secret
+          else
+            c.authorization :Bearer, @bearer_token
+          end
+        end
+        response = conn.get(url)
+      else
+        conn = Faraday.new do |f|
+        end
+        response = conn.post(url)
+      end
+      conn.close
+      Tweetkit::Response.new(response)
+    rescue StandardError => e
+      raise e
+    end
+
+    def auth_token(type = 'bearer')
+      case type
+      when 'bearer'
+        @bearer_token
+      end
+    end
+
+    def build_fields(options)
+      fields = {}
+      _fields = options.delete(:fields)
+      if _fields && _fields.size > 0
+        _fields.each do |key, value|
+          if value.is_a?(Array)
+            _value = value.join(',')
+          else
+            _value = value.delete(' ')
+          end
+          _key = key.to_s.gsub('_', '.')
+          fields.merge!({ "#{_key}.fields" => _value })
+        end
+      end
+      options.each do |key, value|
+        if key.match?('_fields')
+          if value.is_a?(Array)
+            _value = value.join(',')
+          else
+            _value = value.delete(' ')
+          end
+          _key = key.to_s.gsub('_', '.')
+          options.delete(key)
+          fields.merge!({ _key => _value })
+        end
+      end
+      fields
+    end
+
+    def build_expansions(options)
+      expansions = {}
+      _expansions = options.delete(:expansions)
+      if _expansions && _expansions.size > 0
+        _expansions = _expansions.join(',')
+        expansions.merge!({ expansions: _expansions })
+      end
+      expansions
+    end
+
+    def parse_query_and_convenience_headers(options)
+      options = options.dup
+      fields = build_fields(options)
+      options.merge!(fields)
+      expansions = build_expansions(options)
+      options.merge!(expansions)
+      options
+    end
+  end
+end

data/lib/tweetkit/default.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tweetkit
+  module Default
+    class << self
+      def options
+        Hash[Tweetkit::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+    end
+  end
+end

data/lib/tweetkit/response.rb

@@ -0,0 +1,106 @@
+require 'json'
+require 'pry'
+
+module Tweetkit
+  class Response
+    attr_accessor :expansions, :meta, :original_response, :tweets
+
+    def initialize(response)
+      @original_response = response.body
+      parsed_response = JSON.parse(@original_response)
+      @tweets = Tweetkit::Response::Tweets.new(parsed_response)
+      @meta = Tweetkit::Response::Meta.new(@tweets.meta)
+      @expansions = Tweetkit::Response::Expansions.new(@tweets.expansions)
+    end
+
+    class Expansions
+      include Enumerable
+
+      attr_accessor :expansions
+
+      def initialize(expansions)
+        @expansions = expansions
+      end
+
+      def method_missing(attribute, **args)
+        data = expansions[attribute.to_s]
+        data.empty? ? super : data
+      end
+
+      def respond_to_missing?(method)
+        expansions.respond_to? method
+      end
+    end
+
+    class Meta
+      include Enumerable
+
+      attr_accessor :meta
+
+      def initialize(meta)
+        @meta = meta
+      end
+
+      def method_missing(attribute, **args)
+        data = meta[attribute.to_s]
+        data.empty? ? super : data
+      end
+
+      def respond_to_missing?(method)
+        meta.respond_to? method
+      end
+    end
+
+    class Tweets
+      include Enumerable
+
+      attr_accessor :tweets, :meta, :expansions
+
+      def initialize(response)
+        @tweets = response['data'].collect { |tweet| Tweetkit::Response::Tweet.new(tweet) }
+        @meta = response['meta']
+        @expansions = response['includes']
+      end
+
+      def each(*args, &block)
+        tweets.each(*args, &block)
+      end
+
+      def last
+        tweets.last
+      end
+
+      def to_s
+        @tweets.join(' ')
+      end
+
+      def method_missing(attribute, **args)
+        result = tweets.public_send(attribute, **args)
+        super unless result
+      rescue StandardError
+        super
+      end
+
+      def respond_to_missing?(method)
+        tweets.respond_to? method
+      end
+    end
+
+    class Tweet
+      attr_accessor :tweet
+
+      def initialize(tweet)
+        @tweet = tweet
+      end
+
+      def method_missing(attribute)
+        data = tweet[attribute.to_s]
+        data.empty? ? super : data
+      end
+
+      def respond_to_missing?(method)
+        tweet.respond_to? method
+      end
+    end
+  end
+end

data/lib/tweetkit/search.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Tweetkit
+  class Search
+    attr_accessor :search_term
+
+    def initialize(term)
+      @search_term = term + ' '
+    end
+
+    def opts
+      @opts ||= {}
+    end
+
+    def connectors
+      @connectors ||= opts[:connectors] = []
+    end
+
+    def update_search_term(term)
+      @search_term += term
+    end
+
+    def setup(&block)
+      instance_eval(&block)
+    end
+
+    def combined_query
+      @combined_query = "#{@search_term.strip} #{combine_connectors}"
+    end
+
+    def combine_connectors
+      connectors.join(' ')
+    end
+
+    def add_connector(term, grouped: true)
+      grouped ? connectors.push("(#{term})") : connectors.push(term)
+    end
+
+    def build_connector(connector, terms, &block)
+      query = ''
+      connector =
+        connector
+        .to_s
+        .delete_prefix('and_')
+        .delete_prefix('or_')
+        .delete_suffix('_one_of')
+        .to_sym
+      if connector.match?('contains')
+        terms.each do |term|
+          term = term.to_s.strip
+          if term.split.length > 1
+            query += "\"#{term}\" "
+          else
+            query += "#{term} "
+          end
+        end
+        update_search_term(query)
+      elsif connector.match?('without')
+        terms.each do |term|
+          term = term.to_s.strip
+          if term.split.length > 1
+            query += "-\"#{term}\" "
+          else
+            query += "-#{term} "
+          end
+        end
+        add_connector(query.rstrip, grouped: false)
+      elsif connector.match?('is_not')
+        connector = connector.to_s.delete_suffix('_not').to_sym
+        terms.each do |term|
+          term = term.to_s.strip
+          query += "-#{connector}:#{term} "
+        end
+        add_connector(query.rstrip)
+      else
+        terms.each do |term|
+          term = term.to_s.strip
+          query += "#{connector}:#{term} "
+        end
+        add_connector(query.rstrip, grouped: false)
+      end
+      block_given? ? yield : self
+    end
+
+    def build_one_of_connector(connector, terms, &block)
+      query = []
+      connector =
+        connector
+        .to_s
+        .delete_prefix('and_')
+        .delete_prefix('or_')
+        .delete_suffix('_one_of')
+        .to_sym
+      if connector.match?('contains')
+        terms.each do |term|
+          term = term.to_s.strip
+          query << term
+        end
+      else
+        terms.each do |term|
+          term = term.to_s.strip
+          query << "#{connector}: #{term}"
+        end
+      end
+      add_connector(query.join(' OR '))
+      block_given? ? yield : self
+    end
+
+    def method_missing(connector, *terms, &block)
+      if connector.match?('one_of')
+        build_one_of_connector(connector, terms, &block)
+      else
+        build_connector(connector, terms, &block)
+      end
+    end
+
+    def respond_to_missing?(method)
+      method.match?('one_of') || super
+    end
+  end
+end

data/lib/tweetkit/version.rb

@@ -0,0 +1,3 @@
+module Tweetkit
+  VERSION = "0.1.1"
+end

data/tweetkit.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/tweetkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tweetkit"
+  spec.version       = Tweetkit::VERSION
+  spec.authors       = ["Julian Foo"]
+  spec.email         = ["juliandevmy@gmail.com"]
+
+  spec.summary       = %q{WIP: Simple API wrapper for Twitter's V2 API}
+  spec.description   = %q{WIP: Tweetkit is an Octokit-inspired Ruby wrapper for Twitter's V2 API}
+  spec.homepage      = "https://github.com/julianfssen/tweetkit"
+  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"] = spec.homepage
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '>= 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 1.0.0'
+  spec.add_dependency 'simple_oauth', '~> 0.3.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: tweetkit
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julian Foo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: 'WIP: Tweetkit is an Octokit-inspired Ruby wrapper for Twitter''s V2
+  API'
+email:
+- juliandevmy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tweetkit.rb
+- lib/tweetkit/auth.rb
+- lib/tweetkit/client.rb
+- lib/tweetkit/client/tweets.rb
+- lib/tweetkit/configurable.rb
+- lib/tweetkit/connection.rb
+- lib/tweetkit/default.rb
+- lib/tweetkit/response.rb
+- lib/tweetkit/search.rb
+- lib/tweetkit/version.rb
+- tweetkit.gemspec
+homepage: https://github.com/julianfssen/tweetkit
+licenses: []
+metadata:
+  homepage_uri: https://github.com/julianfssen/tweetkit
+  source_code_uri: https://github.com/julianfssen/tweetkit
+  changelog_uri: https://github.com/julianfssen/tweetkit
+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.1.2
+signing_key:
+specification_version: 4
+summary: 'WIP: Simple API wrapper for Twitter''s V2 API'
+test_files: []