meme_generate 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d691279e55adb841bf1af1ec71b43ef7e14529613d9a18a5703d5ec12c165401
4
+ data.tar.gz: 0be1408f2510cc73b9cc60b01a8dc3d62cb6ddcfbf1375912528aee97cabae6d
5
+ SHA512:
6
+ metadata.gz: bba5c6fc249f5e96b058b1dd9bfe285ad71edde37dddc5d1fe7061f8ea2b0e40761a73db3d8fc771ffb8f8e5b41fdade9e4bc8f12bec4e759b62b8986cd9064c
7
+ data.tar.gz: 6811db8bba5223f71110afb2a525298d5c5697ee04047c10d6ea89606da1594f74a1b4cfeb102fca94e04900b99d0f743c3022fa2168986e70595b6c88e86870
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.4.4
7
+ before_install: gem install bundler -v 1.16.3
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at shah.maanav.07@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in meme_generate.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,50 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ meme_generate (0.1.0)
5
+ rest-client (~> 1.7.3)
6
+ unirest
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ addressable (2.5.2)
12
+ public_suffix (>= 2.0.2, < 4.0)
13
+ diff-lcs (1.3)
14
+ json (2.1.0)
15
+ mime-types (2.99.3)
16
+ netrc (0.11.0)
17
+ public_suffix (3.0.2)
18
+ rake (10.5.0)
19
+ rest-client (1.7.3)
20
+ mime-types (>= 1.16, < 3.0)
21
+ netrc (~> 0.7)
22
+ rspec (3.8.0)
23
+ rspec-core (~> 3.8.0)
24
+ rspec-expectations (~> 3.8.0)
25
+ rspec-mocks (~> 3.8.0)
26
+ rspec-core (3.8.0)
27
+ rspec-support (~> 3.8.0)
28
+ rspec-expectations (3.8.1)
29
+ diff-lcs (>= 1.2.0, < 2.0)
30
+ rspec-support (~> 3.8.0)
31
+ rspec-mocks (3.8.0)
32
+ diff-lcs (>= 1.2.0, < 2.0)
33
+ rspec-support (~> 3.8.0)
34
+ rspec-support (3.8.0)
35
+ unirest (1.0.8)
36
+ addressable
37
+ json
38
+ rest-client
39
+
40
+ PLATFORMS
41
+ ruby
42
+
43
+ DEPENDENCIES
44
+ bundler (~> 1.16)
45
+ meme_generate!
46
+ rake (~> 10.0)
47
+ rspec (~> 3.0)
48
+
49
+ BUNDLED WITH
50
+ 1.16.3
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Maanav Shah
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,71 @@
1
+ # meme_generate
2
+ A ruby client for generating memes using https://memegen.link/
3
+
4
+ ## Installation
5
+
6
+ Add this line to your application's Gemfile:
7
+
8
+ ```ruby
9
+ gem 'meme_generate'
10
+ ```
11
+
12
+ And then execute:
13
+
14
+ $ bundle
15
+
16
+ Or install it yourself as:
17
+
18
+ $ gem install meme_generate
19
+
20
+ ## Usage
21
+
22
+ - You can generate the meme using:
23
+
24
+ generate(title, caption, image_url)
25
+
26
+ For example,
27
+
28
+ ```ruby
29
+ generate('Title of meme', 'Caption of the meme', 'https://wallpaperbrowse.com/media/images/pexels-photo-248797.jpeg')
30
+ ```
31
+
32
+ It will provide the information if the title, caption and image_url if is invalid and if the meme is generated or not.
33
+
34
+ - You can get the list of all the fonts using:
35
+ ```ruby
36
+ list_fonts
37
+ ```
38
+
39
+ - You can also add font by simply setting the value of:
40
+ ```ruby
41
+ @font = font_name_from_the_list_of_fonts
42
+ ```
43
+
44
+ - You can also add width and height using:
45
+ ```ruby
46
+ @width = width_integer
47
+ @height = height_integer
48
+ ```
49
+
50
+ - Memegen also provides you a special option to generate shareable images as:
51
+ ```ruby
52
+ @share = true
53
+ ```
54
+
55
+ ## Development
56
+
57
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
58
+
59
+ 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).
60
+
61
+ ## Contributing
62
+
63
+ Bug reports and pull requests are welcome on GitHub at https://github.com/maanavshah/meme_generate. 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.
64
+
65
+ ## License
66
+
67
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
68
+
69
+ ## Code of Conduct
70
+
71
+ Everyone interacting in the MemeGenerate project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maanavshah/meme_generate/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require 'bundler/gem_tasks'
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task default: :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require 'bundler/setup'
4
+ require 'meme_generate'
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require 'irb'
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,13 @@
1
+ require_relative 'meme_generate/version'
2
+ require_relative 'meme_generate/memegen'
3
+
4
+ #
5
+ # Module MemeGenerate provides interface as a ruby client for https://memegen.link/
6
+ #
7
+ # @author Maanav Shah <shah.maanav.07@gmail.com>
8
+ #
9
+ module MemeGenerate
10
+ end
11
+
12
+ # extend Memgen module that directly allows to access methods
13
+ extend Memegen
@@ -0,0 +1,123 @@
1
+ require 'unirest'
2
+ require 'logger'
3
+
4
+ #
5
+ # Module Memegen provides free api driver for https://memegen.link/
6
+ #
7
+ # @author Maanav Shah <shah.maanav.07@gmail.com>
8
+ #
9
+ module Memegen
10
+ attr_accessor :font, :height, :width, :share
11
+
12
+ #
13
+ # Initializes reserved_characters that replaces special characters
14
+ #
15
+ #
16
+ # @return Hash reserved_characters to substitute
17
+ #
18
+ def reserved_characters
19
+ @reserved_characters ||= {
20
+ '_': '__',
21
+ '-': '--',
22
+ ' ': '-',
23
+ '?': '~q',
24
+ '%': '~p',
25
+ '#': '~h',
26
+ '/': '~s',
27
+ '"': "''"
28
+ }
29
+ end
30
+
31
+ #
32
+ # Initializes logger
33
+ #
34
+ #
35
+ # @return Logger Logger instancce
36
+ #
37
+ def logger
38
+ @logger ||= Logger.new(STDOUT)
39
+ end
40
+
41
+ #
42
+ # Get the list of fonts
43
+ #
44
+ #
45
+ # @return Array List of fonts
46
+ #
47
+ def list_fonts
48
+ response = Unirest.get('https://memegen.link/api/fonts')
49
+ response.body
50
+ end
51
+
52
+ #
53
+ # Generate the meme using title, caption and image url
54
+ #
55
+ # @param String title A title for the image
56
+ # @param String caption A caption for the image
57
+ # @param String image An url for image
58
+ #
59
+ # @return File An image
60
+ #
61
+ def generate(title, caption, image)
62
+ # check if title, caption and image is present and valid
63
+ invalid = false
64
+ if title.nil? || title.empty?
65
+ logger.error('Empty title detected')
66
+ invalid = true
67
+ end
68
+ if caption.nil? || caption.empty?
69
+ logger.error('Empty caption detected')
70
+ invalid = true
71
+ end
72
+ url = image.match(/.*(?=\.)/)
73
+ if url.nil? || !image_exists?(url[0])
74
+ logger.error('Image not found')
75
+ invalid = true
76
+ end
77
+
78
+ unless invalid
79
+ # Replace the reserve words
80
+ reserved_characters.each { |k, v| title.gsub!(k.to_s, v.to_s) }
81
+ reserved_characters.each { |k, v| caption.gsub!(k.to_s, v.to_s) }
82
+
83
+ # Generate the url
84
+ url = "https://memegen.link/custom/#{title}/#{caption}.jpg?alt=#{image}"
85
+
86
+ # Parameters
87
+ options = {}
88
+ options[:font] = @font if list_fonts.include?(@font)
89
+ options[:width] = @width.to_i if @width.to_i > 100
90
+ options[:height] = @height.to_i if @height.to_i > 100
91
+ options[:share] = (@share == true)
92
+ options.reject! { |_k, v| v.empty? }
93
+ response = if options.empty? || options.nil?
94
+ Unirest.get(url)
95
+ else
96
+ Unirest.get(url, parameters: options)
97
+ end
98
+
99
+ # Writing image
100
+ File.open("#{Time.now.to_i}.jpeg", 'w+') do |f|
101
+ f.write(response.body)
102
+ f.close
103
+ end
104
+ logger.info('Meme generated')
105
+ end
106
+ end
107
+
108
+ private
109
+
110
+ #
111
+ # Check if the image exists on remote URL
112
+ #
113
+ # @param url A remote image url
114
+ #
115
+ # @return boolean true/false if the image exists or not
116
+ #
117
+ def image_exists?(url)
118
+ uri = URI(url)
119
+ request = Net::HTTP.new uri.host
120
+ response = request.request_head(uri.path)
121
+ [200, 301].include?(response.code.to_i)
122
+ end
123
+ end
@@ -0,0 +1,3 @@
1
+ module MemeGenerate
2
+ VERSION = '0.1.0'.freeze
3
+ end
@@ -0,0 +1,30 @@
1
+ lib = File.expand_path('lib', __dir__)
2
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ require 'meme_generate/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'meme_generate'
7
+ spec.version = MemeGenerate::VERSION
8
+ spec.authors = ['Maanav Shah']
9
+ spec.email = ['shah.maanav.07@gmail.com']
10
+
11
+ spec.summary = 'Meme Generator.'
12
+ spec.description = 'A meme generator using api on https://memegen.link.'
13
+ spec.homepage = 'https://memegen.link/'
14
+ spec.license = 'MIT'
15
+
16
+ # Specify which files should be added to the gem when it is released.
17
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
18
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
19
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
20
+ end
21
+ spec.bindir = 'exe'
22
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
23
+ spec.require_paths = ['lib']
24
+
25
+ spec.add_dependency 'rest-client', '~> 1.7'
26
+ spec.add_dependency 'unirest', '~> 1.0'
27
+ spec.add_development_dependency 'bundler', '~> 1.16'
28
+ spec.add_development_dependency 'rake', '~> 10.0'
29
+ spec.add_development_dependency 'rspec', '~> 3.0'
30
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: meme_generate
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Maanav Shah
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-08-16 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rest-client
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: unirest
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.16'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.16'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '3.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '3.0'
83
+ description: A meme generator using api on https://memegen.link.
84
+ email:
85
+ - shah.maanav.07@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - Gemfile.lock
96
+ - LICENSE.txt
97
+ - README.md
98
+ - Rakefile
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/meme_generate.rb
102
+ - lib/meme_generate/memegen.rb
103
+ - lib/meme_generate/version.rb
104
+ - meme_generate.gemspec
105
+ homepage: https://memegen.link/
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.7.7
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Meme Generator.
129
+ test_files: []