tweetkit 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9fe5ece4cef00bc50ac604a61d38321fb9aeeef648f6586696d0c1b1e14391c
-  data.tar.gz: bafdeeda01397333a669aa4dc5eb9021b3c934995a82b1116de74e5f8a7202f9
+  metadata.gz: 20539d0c3da14a28107d1fdf85fffcbe6c092b0ec885162ccd487baeb7e2976e
+  data.tar.gz: 95eab7a0384b95895fafe9371235ea9192603f66db6a722fa0842872d2014939
 SHA512:
-  metadata.gz: e832b0ac7583b4604eca6db1a79615ea86d984191cdd03efcae7fa44215b5a8d1bd78b760312d7e544c595f6c24843983b54e87b4d8f58dfee6e4fa828ea6f9f
-  data.tar.gz: '045117388ada745f039095a51a0e59583509d984eb8bdab308366b14e27dc8908a5849d7f5da436c480ea1fd1b415e87201ee0174298d6ce2f150f4bc7925bd8'
+  metadata.gz: 7caa31d80a32d88968f1f0cb8945ff9dbaf960e363f2572e4a3cde7c41cf19797f74cd99a6699372bed3725e3f39e67121270a83409fb7ad467dd2b732bff99a
+  data.tar.gz: a8f3085fc4e221036c08fc3aba617847d693a4494520abd55c8a4262ac03e659dd944e139557856c59379bdb4a8382f7a0de131e0a461c9f50b14cc895aa32db

data/.env.example

@@ -0,0 +1,5 @@
+BEARER_TOKEN=<your-bearer-token>
+CONSUMER_KEY=<your-consumer-key>
+CONSUMER_SECRET=<your-consumer-secret>
+ACCESS_TOKEN=<your-access-token>
+ACCESS_TOKEN_SECRET=<your-access-token-secret>

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env
+!.env.example

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to `tweetkit` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2022-01-09
+### Added
+- Added the ability to add OAuth tokens when setting up the client instance. Credit to @rofreg
+- Added OAuth as an option to authenticate requests. Credit to @rofreg
+- Added the `post_tweet` method to post tweets via OAuth. Credit to @rofreg
+- Added the `delete_tweet` method to delete tweets via OAuth. Credit to @rofreg
+- Added tests for the `Tweets` module.
+- Added tests for the `Search` module.
+- Added tests for search building and cleaning in the `Conjunctions` class.
+### Changed
+- Updated client responses to return a `Tweetkit::Response` object. The `Tweetkit::Response` object contains a `Tweets` object that is made up of `Tweet` objects that contain the data for each respective tweet. `Fields` and `Expansions` objects are also available depending on the fields and expansions made in the request.
+- Moved search building and cleaning logic to the `Conjunctions` class.
+- Fixed wrong config key names when setting up the client. Credit to @dewey
+### Removed
+- No changes

data/Gemfile

@@ -5,10 +5,15 @@ gemspec
 
 gem 'faraday'
 gem 'faraday_middleware'
-gem "minitest", "~> 5.0"
 gem "rake", "~> 12.0"
 gem 'simple_oauth', "~> 0.3.0"
 
+group :development do
+  gem 'yard'
+end
+
 group :test, :development do
+  gem 'dotenv'
   gem 'pry', '~> 0.13.1'
+  gem 'rspec'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tweetkit (0.1.0)
+    tweetkit (0.1.4)
       faraday (>= 0.9)
       faraday_middleware (~> 1.0.0)
       simple_oauth (~> 0.3.0)
@@ -10,42 +10,63 @@ GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
-    faraday (1.4.2)
+    diff-lcs (1.4.4)
+    dotenv (2.7.6)
+    faraday (1.5.1)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
       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-httpclient (1.0.1)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.1.0)
+    faraday-patron (1.0.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)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
     ruby2_keywords (0.0.4)
     simple_oauth (0.3.1)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  dotenv
   faraday
   faraday_middleware
-  minitest (~> 5.0)
   pry (~> 0.13.1)
   rake (~> 12.0)
+  rspec
   simple_oauth (~> 0.3.0)
   tweetkit!
+  yard
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Julian Foo Siang Sen
+
+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

@@ -37,13 +37,13 @@ Or install it yourself as:
   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')
+  client = Tweetkit::Client.new(bearer_token: 'YOUR_BEARER_TOKEN_HERE', consumer_key: 'YOUR_CONSUMER_KEY_HERE', consumer_secret: 'YOUR_CONSUMER_SECRET_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'
+    config.consumer_key = 'YOUR_CONSUMER_KEY_HERE'
+    config.consumer_secret = 'YOUR_CONSUMER_SECRET_HERE'
   end
 ```
 
@@ -59,7 +59,9 @@ 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.
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To run tests, first copy `.env.example` to `.env`, and modify it to include a valid Bearer token for the Twitter v2 API. Then, run `bundle exec rspec` 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).
 

data/Rakefile

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

data/bin/console

@@ -2,6 +2,8 @@
 
 require "bundler/setup"
 require "tweetkit"
+require 'dotenv'
+BASE_ENV_FILE_PATH = '.env'
 
 # 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.
@@ -11,4 +13,21 @@ require "tweetkit"
 # Pry.start
 
 require "irb"
+
+Dotenv.load(BASE_ENV_FILE_PATH)
+
+def reload!
+  puts 'Reloading ...'
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
 IRB.start(__FILE__)

data/lib/tweetkit/auth.rb

@@ -1,11 +1,7 @@
 module Tweetkit
   module Auth
-    def basic_auth?
-      !!(@login && @password)
-    end
-
     def token_auth?
-      !!(@access_token && @access_token_secret)
+      !!(@consumer_key && @consumer_secret && @access_token && @access_token_secret)
     end
 
     def bearer_auth?