themealdb_rubygem 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 919495981493a8cd54ee0d20c825483a584b22b89957e023e95fba1371c1d7b8
+  data.tar.gz: fe2a4f9c936a419e6051b00d9c8a2b5ad3aeebc4b3822a3a6a41dca66baa666c
+SHA512:
+  metadata.gz: 73e8833bdf61a4f009bfccdbdae20c71712af03afe752dbfe52f4c8e62942310e2d75e237fdcd2243bb3c09e6fa4fb95774261a840b31a5ed4707c0e026da2d8
+  data.tar.gz: 7a663e8c5ab17cb2f0bb46a371717136ea434b61d70f38db3bbd8c8707ed0c8bf4ad5f490ac02835383ba4e80afe82851475361fd40b0de19b7b5ed9ccbe1fcf

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in themealdb_rubygem.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    themealdb_rubygem (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      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)
+      faraday-rack (~> 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.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    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.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  themealdb_rubygem!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,119 @@
+# The MealDB API
+
+This gem is for educational use only. I have created this to have a practice on how to create an API wrapper for Rails and create it in a ruby gem.
+
+You may check The MealDB website [here](https://www.themealdb.com/api.php). The API and their site will always remain free at point of access. If you love their service and want extra features you can sign up as a [Patreon supporter](https://www.patreon.com/thedatadb) for $2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'themealdb_rubygem'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install themealdb_rubygem
+    
+## Usage
+
+
+### Configure
+Instance of the client must be done first before being able to use the API. Since The MealDB have endpoints for free users and paid users, you can just create an instance without passing any api_key.
+
+#### free
+
+```ruby
+client = ThemealdbRubygem::Client.new
+```
+
+#### with api key (paid)
+
+```ruby
+client = ThemealdbRubygem::Client.new(api_key: YOUR_API_KEY)
+```
+
+### Search meal by name
+
+```ruby
+client.search_by_name("Arrabiata")
+```
+
+### Search by first letter
+
+```ruby
+client.search_by_first_letter("a")
+```
+
+### Search by ID
+
+```ruby
+client.search_by_id("52772")
+```
+
+### Random Meal
+
+```ruby
+client.random_meal
+```
+
+### List all categories with full description
+
+```ruby
+client.list_categories_full
+```
+
+### List all categories
+
+```ruby
+client.list_categories
+```
+
+### List all area
+
+```ruby
+client.list_areas
+```
+
+### List all ingredients
+
+```ruby
+client.list_ingredients
+```
+
+### Filter by main ingredient
+Note that for paid users (those with api keys), ingredient variable can hold multiple strings (ingredient = "chicken_breast,garlic,salt").
+
+```ruby
+client.filter_by_main_ingredient("chicken breast")
+```
+
+### Filter by category
+
+```ruby
+client.filter_by_category("Seafood")
+```
+
+### Filter by area
+
+```ruby
+client.filter_by_area("Canadian")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/michael-dollosa/themealdb_rubygem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/michael-dollosa/themealdb_rubygem/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ChallongeUserRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/michael-dollosa/themealdb_rubygem/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,113 @@
+require "faraday"
+require "faraday_middleware"
+
+module ThemealdbRubygem
+  class Client
+    BASE_URL = "https://www.themealdb.com/api/json/v1/1/"
+
+    attr_reader :adapter, :api_key
+
+    def initialize(api_key: nil, adapter: Faraday.default_adapter)
+      @adapter = adapter
+      @api_key = api_key
+      @url = api_key.nil? ? BASE_URL : "https://www.themealdb.com/api/json/v2/#{api_key}/" 
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = @url
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter
+        conn.headers['Accept'] = 'application/json'
+        conn.use Faraday::Response::RaiseError
+      end
+    end
+
+    #endpoints
+    def search_by_name(name)
+      response = connection.get("search.php", {s: name})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+
+    def search_by_first_letter(letter)
+      response = connection.get("search.php", {f: letter})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+
+    def search_by_id(id)
+      response = connection.get("lookup.php", {i: id})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+
+    def random_meal
+      response = connection.get("random.php")
+      { code: response.status, data: response.body }
+    end
+    
+    def list_categories_full
+      response = connection.get("categories.php")
+      { code: response.status, data: response.body }
+    end
+
+    def list_categories
+      response = connection.get("list.php", {c: 'list'})
+      { code: response.status, data: response.body }
+    end
+
+    def list_areas
+      response = connection.get("list.php", {a: 'list'})
+      { code: response.status, data: response.body }
+    end
+
+    def list_ingredients
+      response = connection.get("list.php", {i: 'list'})
+      { code: response.status, data: response.body }
+    end
+
+    def filter_by_main_ingredient(ingredient)
+      # clean up spaces in search string
+      str = ingredient.gsub(/\s+,/, ',').gsub(/,\s+/, ',').strip
+      response = connection.get("filter.php", {i: str})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+
+    def filter_by_category(category)
+      #clean up spaces in search string
+      str = category.gsub(/\s+,/, ',').gsub(/,\s+/, ',').strip
+      response = connection.get("filter.php", {c: str})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+
+    def filter_by_area(area)
+      #clean up spaces in search string
+      str = area.gsub(/\s+,/, ',').gsub(/,\s+/, ',').strip
+      response = connection.get("filter.php", {a: str})
+      if response.body["meals"]
+        { code: response.status, data: response.body }
+      else
+        { code: 404, data: 'No meals found' }
+      end
+    end
+  end
+end

data/lib/themealdb_rubygem/version.rb

@@ -0,0 +1,3 @@
+module ThemealdbRubygem
+  VERSION = "0.1.0"
+end

data/lib/themealdb_rubygem.rb

@@ -0,0 +1,6 @@
+require "themealdb_rubygem/version"
+
+module ThemealdbRubygem
+  autoload :Client, "themealdb_rubygem/client"
+  class Error < StandardError; end
+end

data/themealdb_rubygem.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/themealdb_rubygem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "themealdb_rubygem"
+  spec.version       = ThemealdbRubygem::VERSION
+  spec.authors       = ["Christian Michael Dollosa"]
+  spec.email         = ["dollosa.christian@gmail.com"]
+
+  spec.summary       = %q{TheMealDB API Wrapper for rails projects}
+  spec.description   = %q{TheMealDB API Wrapper for rails projects}
+  spec.homepage      = "https://github.com/michael-dollosa/themealdb_rubygem"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # 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('..', __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"]
+
+  #add dependency
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: themealdb_rubygem
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Michael Dollosa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: TheMealDB API Wrapper for rails projects
+email:
+- dollosa.christian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/themealdb_rubygem.rb
+- lib/themealdb_rubygem/client.rb
+- lib/themealdb_rubygem/version.rb
+- themealdb_rubygem.gemspec
+homepage: https://github.com/michael-dollosa/themealdb_rubygem
+licenses:
+- MIT
+metadata: {}
+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.6
+signing_key:
+specification_version: 4
+summary: TheMealDB API Wrapper for rails projects
+test_files: []