fatsecret_lite 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7584e18f7582144db2d123d875f0be9f69dd01ac2fa7debb0d66adc8b9acb1e
-  data.tar.gz: 81208a3c4486882ab4c9c4b8974dec4fcb2e4661f6eee776826bef32a509e429
+  metadata.gz: 8a173a429e88edc9e5ce1532dc053e558e6c7618c4762f94e424611cdbbff411
+  data.tar.gz: c473ea90439d2d1d3b6cd23f87d0e516594a0515bc832d0efc8febbe2d4bc311
 SHA512:
-  metadata.gz: 27b122bb6edbc1bd797e8ccf07909f4fe3edc0bbb3c25934f1785a0d1115865c1ea14a43489099989f46970dcdc2aeef8bb8e957230c63f577ff1b10a6bfce7b
-  data.tar.gz: 7e747ea866a35c162eee409c71d5e3ec04ff6bba70e86f1bef431dd4ea808c4c68cb0d56f09111bccd8e5dbf23b9f201e06205b79e113b274597b8f558463bfa
+  metadata.gz: 7f3464c9270330f3bac9f4d52a06d6ad44be44be3b8c42974f6ca1af42bf8cbb773245bf6bca8bbe05048995838ad78392005a79370876c749a8947f98397d91
+  data.tar.gz: 1348315971741c0cb110da9277d9487208eb460d391668306d0908cd87bd795a2eaafd0a6c00c9eb668b31f9ecb7a1a5693157cb57be420efaf84bd9b1f611bd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-23
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+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.
+
+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.
+
+## Scope
+
+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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dev.kapildevpal@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**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.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**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.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**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.
+
+### 4. Permanent Ban
+
+**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.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kapil Dev Pal
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 KapilDevPal
+
+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,84 @@
+Here's the corrected and cleaned-up version of your README file:
+
+markdown
+Copy code
+# FatsecretLite
+
+`fatsecret_lite` is a Ruby gem for interacting with the FatSecret API. It provides an easy way to retrieve food details using OAuth2 authentication. The gem is available at: [https://rubygems.org/gems/fatsecret_lite](https://rubygems.org/gems/fatsecret_lite).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fatsecret_lite'
+And then execute:
+
+bash
+Copy code
+bundle install
+Or install it yourself as:
+
+bash
+Copy code
+gem install fatsecret_lite
+Usage
+Configuration
+Before using the gem, you need to configure it with your FatSecret API credentials. You can do this in an initializer or before making any API calls.
+
+Example configuration:
+
+ruby
+Copy code
+FatsecretLite.configure do |config|
+  config.client_id = 'your_client_id'
+  config.client_secret = 'your_client_secret'
+end
+Replace 'your_client_id' and 'your_client_secret' with your actual FatSecret API credentials.
+
+Fetching Food Details
+To fetch food details by food ID, use the get_food_details method:
+
+ruby
+Copy code
+food_details = FatsecretLite.get_food_details(12345)
+puts food_details
+This will return the details for the food item with the specified ID in a JSON format.
+
+Development
+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.
+
+To install this gem onto your local machine, run:
+
+bash
+Copy code
+bundle exec rake install
+To release a new version, update the version number in lib/fatsecret_lite/version.rb, and then run:
+
+bash
+Copy code
+bundle exec rake release
+This will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.
+
+Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/KapilDevPal/fatsecret_lite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
+
+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 FatsecretLite project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the code of conduct.
+
+markdown
+Copy code
+
+### Key Changes:
+1. Fixed formatting and indentation issues.
+2. Added missing headings and clear sections.
+3. Corrected URLs to GitHub and Rubygems links.
+4. Adjusted code blocks for proper syntax highlighting.
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/fatsecret_lite.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "lib/fatsecret_lite/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fatsecret_lite"
+  spec.version = FatsecretLite::VERSION
+  spec.authors = ["KapilDevPal"]
+  spec.email = ["dev.kapildevpal@gmail.com"]
+
+  spec.summary     = "A lightweight Ruby gem for interacting with the FatSecret API"
+  spec.description = "This gem provides a simple interface to interact with the FatSecret API using OAuth2 and RestClient."
+  # spec.homepage    = "https://github.com/KapilDevPal/fatsecret_lite"
+  spec.license     = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  # spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/KapilDevPal/fatsecret_lite"
+  spec.metadata["changelog_uri"] = "https://github.com/KapilDevPal/fatsecret_lite/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Add dependencies for your gem
+  spec.add_dependency "oauth2", "~> 1.4"
+  spec.add_dependency "rest-client", "~> 2.1"
+  spec.add_dependency "json"
+
+  # Post-installation message
+  spec.post_install_message = <<-MESSAGE
+  Thank you for installing the FatSecret Lite gem!
+  Hey! My name is Kapil Dev Pal incase if haveing any issue installing this gem please:
+  contact me @email: dev.KapilDev@gmail.com
+  Happy coding!
+  MESSAGE
+
+  # No executable files to include
+  spec.bindir        = "bin"
+  spec.executables = []
+end

data/lib/fatsecret_lite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FatsecretLite
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/lib/fatsecret_lite.rb

@@ -2,10 +2,8 @@
 require "oauth2"
 require "rest-client"
 require "json"
-require_relative 'fatsecret_search'
 
 module FatsecretLite
-  extend FatsecretSearch
   class Configuration
     attr_accessor :client_id, :client_secret
 
@@ -88,6 +86,29 @@ module FatsecretLite
     rescue StandardError => e
       puts "An error occurred: #{e.message}"
     end
+
+    def find_food_by_search(search_value, max_results= 10)
+        access_token = get_access_token
+
+        response = RestClient.post(
+          'https://platform.fatsecret.com/rest/server.api',
+          {
+            method: 'foods.search.v3',
+            max_results: max_results,
+            search_expression: search_value,
+            format: 'json'
+          },
+          {
+            content_type: :json,
+            Authorization: "Bearer #{access_token}"
+          }
+        )
+
+        JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        puts "Error: #{e.response}"
+      rescue StandardError => e
+        puts "An error occurred: #{e.message}"
+      end
   end
-  include FatsecretLite::Search
 end

data/sig/fatsecret_lite.rbs

@@ -0,0 +1,4 @@
+module FatsecretLite
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fatsecret_lite
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - KapilDevPal
@@ -60,15 +60,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- fatsecret_lite.gemspec
 - lib/fatsecret_lite.rb
 - lib/fatsecret_lite/configuration.rb
 - lib/fatsecret_lite/version.rb
-homepage: https://github.com/KapilDevPal/fatsecret_lite
+- sig/fatsecret_lite.rbs
+homepage: 
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/KapilDevPal/fatsecret_lite
   source_code_uri: https://github.com/KapilDevPal/fatsecret_lite
   changelog_uri: https://github.com/KapilDevPal/fatsecret_lite/CHANGELOG.md
 post_install_message: |2