twtxt 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 16631200006f6643b550e20b2c4efe64f07fc7c6c4845908bc03d2bb1fd13c3f
4
+ data.tar.gz: 1874db2de7ac8b89c9a9c35e2704ea863c3469701202628e4d496392ab143cb0
5
+ SHA512:
6
+ metadata.gz: 12528305dfe4726d91c354b2986706a38863e959f3ff55597cccc76b825e462613498ba3e55b799debb495ec6709335548d9a5988d34f89c2533a7b093164bfd
7
+ data.tar.gz: dbf7fee0796a4658096a07dd1713a9c88969460cc5a8e11d3a860c561422a7ffb6723ce8c4a0355483cde127a1abe26a2250a45e932cc4004084d474c362e50e
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2023-05-06
4
+
5
+ - Initial release
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at shreyan.jain.9@outlook.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ source "https://rubygems.org"
4
+
5
+ # Specify your gem's dependencies in twtxt.gemspec
6
+ gemspec
7
+
8
+ gem "rake", "~> 13.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,25 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ twtxt (0.0.1)
5
+ httparty
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ httparty (0.21.0)
11
+ mini_mime (>= 1.0.0)
12
+ multi_xml (>= 0.5.2)
13
+ mini_mime (1.1.2)
14
+ multi_xml (0.6.0)
15
+ rake (13.0.6)
16
+
17
+ PLATFORMS
18
+ x86_64-darwin-22
19
+
20
+ DEPENDENCIES
21
+ rake (~> 13.0)
22
+ twtxt!
23
+
24
+ BUNDLED WITH
25
+ 2.4.12
data/LICENSE ADDED
@@ -0,0 +1,10 @@
1
+ This is free and unencumbered software released into the public domain.
2
+
3
+ Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
4
+
5
+ In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and
6
+ successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
7
+
8
+ 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 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.
9
+
10
+ For more information, please refer to <http://unlicense.org/>
data/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # twtxt
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/twtxt`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ ## Installation
6
+
7
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
8
+
9
+ Install the gem and add to the application's Gemfile by executing:
10
+
11
+ $ bundle add twtxt
12
+
13
+ If bundler is not being used to manage dependencies, install the gem by executing:
14
+
15
+ $ gem install twtxt
16
+
17
+ ## Usage
18
+
19
+ TODO: Write usage instructions here
20
+
21
+ ## Development
22
+
23
+ After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
24
+
25
+ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
26
+
27
+ ## Contributing
28
+
29
+ Bug reports and pull requests are welcome on GitHub at https://codeberg.org/shreyan/twtxt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://codeberg.org/shreyan/twtxt/blob/main/CODE_OF_CONDUCT.md).
30
+
31
+ ## License
32
+
33
+ The gem is available as open source under the terms of the [Unlicense](https://opensource.org/licenses/Unlicense).
34
+
35
+ ## Code of Conduct
36
+
37
+ Everyone interacting in the Twtxt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codeberg/twtxt/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,4 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ task default: %i[]
data/deploy.sh ADDED
@@ -0,0 +1,29 @@
1
+ #!/bin/bash
2
+
3
+ # get the version number from lib/twtxt/version.rb
4
+ VERSION=$(cat lib/twtxt/version.rb | grep VERSION | awk '{ print $3 }' | tr -d '"')
5
+
6
+ # prompt for confirmation and new version number
7
+ read -p "Are you sure you want to release version $VERSION? [y/n]: " CONFIRM
8
+ if [ "$CONFIRM" == "n" ]; then
9
+ echo "Aborting release process."
10
+ exit 1
11
+ fi
12
+
13
+ read -p "Enter new version number (leave blank to keep $VERSION): " NEW_VERSION
14
+ if [ -n "$NEW_VERSION" ]; then
15
+ echo "Updating version number to $NEW_VERSION."
16
+ sed -i '' "s/VERSION = \"$VERSION\"/VERSION = \"$NEW_VERSION\"/" lib/twtxt/version.rb
17
+ VERSION=$NEW_VERSION
18
+ fi
19
+
20
+ # build the gem
21
+ echo "Building gem..."
22
+ gem build twtxt.gemspec
23
+
24
+ # push the gem to RubyGems
25
+ read -p "Push gem to RubyGems? [y/n]: " PUSH_GEM
26
+ if [ "$PUSH_GEM" == "y" ]; then
27
+ echo "Pushing gem to RubyGems..."
28
+ gem push twtxt-$VERSION.gem
29
+ fi
data/install-local.sh ADDED
@@ -0,0 +1,11 @@
1
+ #!/bin/bash
2
+
3
+ # get the current version from lib/twtxt/version.rb
4
+ VERSION=`cat lib/twtxt/version.rb | grep "VERSION =" | cut -d '"' -f 2`
5
+ echo "Building gem version $VERSION"
6
+
7
+ # build the gem
8
+ gem build twtxt.gemspec
9
+
10
+ # install the gem locally
11
+ gem install ./twtxt-$VERSION.gem
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Twtxt
4
+ VERSION = "0.0.1"
5
+ end
data/lib/twtxt/yarn.rb ADDED
@@ -0,0 +1,66 @@
1
+ require "httparty"
2
+ require "json"
3
+
4
+ module Twtxt
5
+ module Yarn
6
+ def api_endpoint(yarnpod)
7
+ "https://#{yarnpod}/api/v1"
8
+ end
9
+
10
+ def get_jwt_token(username, password, endpoint)
11
+ response = HTTParty.post("#{endpoint}/auth", body: { username: username, password: password }.to_json, headers: { "Content-Type" => "application/json" })
12
+ JSON.parse(response.body)["token"]
13
+ end
14
+
15
+ def authenticated_headers(token)
16
+ { "Token" => "#{token}", "Content-Type" => "application/json" }
17
+ end
18
+
19
+ class Credentials
20
+ attr_reader :username, :password, :yarnpod
21
+
22
+ def initialize(username, password, yarnpod)
23
+ @username = username
24
+ @password = password
25
+ @yarnpod = yarnpod
26
+ end
27
+ end
28
+
29
+ class Session
30
+ include HTTParty
31
+ include Yarn
32
+ attr_reader :credentials, :endpoint, :token, :headers
33
+
34
+ def initialize(credentials)
35
+ @credentials = credentials
36
+ @endpoint = api_endpoint(credentials.yarnpod)
37
+ @token = get_jwt_token(credentials.username, credentials.password, self.endpoint)
38
+ @headers = authenticated_headers(self.token)
39
+ end
40
+
41
+ def ping
42
+ self.class.get("#{@endpoint}/ping", headers: @headers)
43
+ end
44
+
45
+ def whoami
46
+ self.class.get("#{@endpoint}/whoami", headers: @headers)
47
+ end
48
+
49
+ # def get_profile_twts(username, page)
50
+ # self.class.get("#{@endpoint}/profile/#{username}/twts?page=#{page}", headers: @headers)
51
+ # end
52
+
53
+ def get_profile(username)
54
+ self.class.get("#{@endpoint}/profile/#{username}", headers: @headers)
55
+ end
56
+
57
+ def get_twtxt(profile)
58
+ self.class.get("https://#{credentials.yarnpod}/user/#{profile}/twtxt.txt", headers: @headers)
59
+ end
60
+
61
+ def post_twt(twt_text)
62
+ self.class.post("#{@endpoint}/post", body: { text: twt_text, post_as: "#{@credentials.username}" }.to_json, headers: @headers)
63
+ end
64
+ end
65
+ end
66
+ end
data/lib/twtxt.rb ADDED
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "twtxt/version"
4
+ require "twtxt/yarn"
5
+ require "twtxt/txt"
6
+
7
+ module Twtxt
8
+ class Error < StandardError; end
9
+
10
+ # Your code goes here...
11
+ end
data/sig/twtxt.rbs ADDED
@@ -0,0 +1,4 @@
1
+ module Twtxt
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
data/twtxt.gemspec ADDED
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/twtxt/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "twtxt"
7
+ spec.version = Twtxt::VERSION
8
+ spec.authors = ["Shreyan Jain"]
9
+ spec.email = ["shreyan.jain.9@outlook.com"]
10
+
11
+ spec.summary = ""
12
+ spec.description = ""
13
+ spec.homepage = "https://shreyan.codeberg.io/twtxt"
14
+ spec.license = "Unlicense"
15
+ spec.required_ruby_version = ">= 3.1.2"
16
+
17
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
18
+
19
+ spec.metadata["homepage_uri"] = spec.homepage
20
+ spec.metadata["source_code_uri"] = "https://codeberg.org/shreyan/twtxt"
21
+
22
+ # Specify which files should be added to the gem when it is released.
23
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
24
+ spec.files = Dir.chdir(__dir__) do
25
+ `git ls-files -z`.split("\x0").reject do |f|
26
+ (File.expand_path(f) == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
27
+ end
28
+ end
29
+ spec.bindir = "exe"
30
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
31
+ spec.require_paths = ["lib"]
32
+
33
+ # Uncomment to register a new dependency of your gem
34
+ spec.add_dependency "httparty"
35
+
36
+ # For more information and examples about making a new gem, check out our
37
+ # guide at: https://bundler.io/guides/creating_gem.html
38
+ end
metadata ADDED
@@ -0,0 +1,74 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: twtxt
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Shreyan Jain
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-05-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: httparty
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ description: ''
28
+ email:
29
+ - shreyan.jain.9@outlook.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - CHANGELOG.md
35
+ - CODE_OF_CONDUCT.md
36
+ - Gemfile
37
+ - Gemfile.lock
38
+ - LICENSE
39
+ - README.md
40
+ - Rakefile
41
+ - deploy.sh
42
+ - install-local.sh
43
+ - lib/twtxt.rb
44
+ - lib/twtxt/version.rb
45
+ - lib/twtxt/yarn.rb
46
+ - sig/twtxt.rbs
47
+ - twtxt.gemspec
48
+ homepage: https://shreyan.codeberg.io/twtxt
49
+ licenses:
50
+ - Unlicense
51
+ metadata:
52
+ allowed_push_host: https://rubygems.org
53
+ homepage_uri: https://shreyan.codeberg.io/twtxt
54
+ source_code_uri: https://codeberg.org/shreyan/twtxt
55
+ post_install_message:
56
+ rdoc_options: []
57
+ require_paths:
58
+ - lib
59
+ required_ruby_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: 3.1.2
64
+ required_rubygems_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ requirements: []
70
+ rubygems_version: 3.4.12
71
+ signing_key:
72
+ specification_version: 4
73
+ summary: ''
74
+ test_files: []