fera-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83807e83ab901ad55674c52bad255fbdd28f3b836d3f0f0cec9e6d89706c7b9a
+  data.tar.gz: 95ef78772948857fa52d558e2fe41d40d733ebaf98c9758ecb51629526108ef9
+SHA512:
+  metadata.gz: c3c2d2272a78519eec6fe20f44a34604cbd52de17147f9c1fcd258534e0a852e40be5b454bcfe4c960c818341ceda9083bbd41af0af4e1b74cddc61fc1a4296a
+  data.tar.gz: d678db7fd72623971f81da4d6a7ce6be13ce46dc486ba061f233008b8cb115360a54dc05bc169b4de3d8f9b20eac1b2106e8833b9d91f624e3b43ab343c5df9d

data/.idea/fera-api.iml

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="jdk" jdkName="rbenv: 2.7.6" jdkType="RUBY_SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v6.1.6, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel-serializers-xml (v1.0.2, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activeresource (v6.0.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.6, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="aes_key_wrap (v1.1.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bindata (v2.4.10, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.13, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.10.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json-jwt (v1.13.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.16.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.4.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="require_all (v3.0.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.1, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.29.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.17.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.4, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.1.0, rbenv: 2.7.6) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.4, rbenv: 2.7.6) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build fera-api-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if fera-api-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install fera-api-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install fera-api-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push fera-api-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
+          <RakeTaskImpl id="rubocop">
+            <subtasks>
+              <RakeTaskImpl description="Auto-correct RuboCop offenses" fullCommand="rubocop:auto_correct" id="auto_correct" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/fera-api.iml" filepath="$PROJECT_DIR$/.idea/fera-api.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.idea/workspace.xml

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="009b0e7e-780b-4a53-b5af-225beb092db6" name="Changes" comment="">
+      <change afterPath="$PROJECT_DIR$/.github/workflows/checks.yml" afterDir="false" />
+      <change afterPath="$PROJECT_DIR$/lib/fera/models/concerns/has_subject.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.github/workflows/main.yml" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.rubocop.yml" beforeDir="false" afterPath="$PROJECT_DIR$/.rubocop.yml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/fera-api.gemspec" beforeDir="false" afterPath="$PROJECT_DIR$/fera-api.gemspec" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/api.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/fera/api.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/models/base.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/fera/models/base.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/models/media.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/fera/models/media.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/models/product_rating.rb" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/models/rating.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/fera/models/rating.rb" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/fera/models/review.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/fera/models/review.rb" afterDir="false" />
+    </list>
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="2CUN8QyrfMp0BzU6I2ao6g1dJ5J" />
+  <component name="ProjectLevelVcsManager">
+    <ConfirmationsSetting value="1" id="Add" />
+  </component>
+  <component name="ProjectViewState">
+    <option name="autoscrollFromSource" value="true" />
+    <option name="autoscrollToSource" value="true" />
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "ASKED_SHARE_PROJECT_CONFIGURATION_FILES": "true",
+    "RunOnceActivity.OpenProjectViewOnStart": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "last_opened_file_path": "/Users/jay.el-kaake/Sites/wf/bananastand/sdks/ruby/fera-api/.github",
+    "nodejs_package_manager_path": "npm",
+    "ruby.rails.projectView.checked": "true"
+  }
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/.github" />
+      <recent name="$PROJECT_DIR$/lib/fera/models/concerns" />
+    </key>
+    <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/lib/fera/models" />
+      <recent name="$PROJECT_DIR$/lib/fera/api" />
+      <recent name="$PROJECT_DIR$/lib/fera/models/concerns" />
+      <recent name="$PROJECT_DIR$/lib/fera" />
+    </key>
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="SpringUtil" SPRING_PRE_LOADER_OPTION="true" RAKE_SPRING_PRE_LOADER_OPTION="true" RAILS_SPRING_PRE_LOADER_OPTION="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="009b0e7e-780b-4a53-b5af-225beb092db6" name="Changes" comment="" />
+      <created>1658853043250</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1658853043250</updated>
+      <workItem from="1658853044517" duration="2379000" />
+      <workItem from="1658882747177" duration="20940000" />
+    </task>
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+</project>

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,56 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/LeadingCommentSpace:
+  Enabled: false
+Layout/LineLength:
+  Max: 200
+# If AbcSize > 50, really really really really really really really complex
+Metrics/AbcSize:
+  Max: 50
+# Use the default setting
+Metrics/BlockNesting:
+  Enabled: true
+Metrics/BlockLength:
+  Max: 200
+  Exclude:
+    # RuboCop's default
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    # In many cases, config/routes.rb has very long blocks
+    - 'config/routes.rb'
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 30
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 4
+Metrics/PerceivedComplexity:
+  Enabled: false
+Layout/TrailingEmptyLines:
+  Enabled: false
+Layout/TrailingWhitespace:
+  Enabled: false
+Layout/BlockAlignment:
+  Enabled: false
+Layout/DefEndAlignment:
+  Enabled: false
+Layout/EndAlignment:
+  Enabled: false
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+Layout/LeadingEmptyLines:
+  Enabled: false
+Layout/SpaceInsideStringInterpolation:
+  EnforcedStyle: space

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fera.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :development, :test do
+  gem "rspec", "~> 3.0"
+
+  gem "rubocop"
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    fera-api (0.1.0)
+      activemodel (>= 4)
+      activeresource (>= 6)
+      activesupport (>= 5.0)
+      json-jwt (>= 1)
+      require_all (>= 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.6)
+      activesupport (= 6.1.6)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activeresource (6.0.0)
+      activemodel (>= 6.0)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 6.0)
+    activesupport (6.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    aes_key_wrap (1.1.0)
+    ast (2.4.2)
+    bindata (2.4.10)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    json-jwt (1.13.0)
+      activesupport (>= 4.2)
+      aes_key_wrap
+      bindata
+    minitest (5.16.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.4.0)
+    require_all (3.0.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-darwin-18
+  x86_64-darwin-20
+
+DEPENDENCIES
+  fera-api!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jay El-Kaake
+
+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,256 @@
+# Introduction
+
+Welcome to the Fera API gem for Ruby. This gem is Fera's official Ruby SDK and make it easy to interact with the Fera API.
+
+Fera API Developer Docs and API Reference can be found at: [https://developers.fera.ai](developers.fera.ai)
+
+# Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```ruby
+  gem 'fera', '~> 0.1'
+```
+
+# Configuration
+The Fera::API gem accepts 2 [both Secret/API Key authentication](https://developers.fera.ai/docs/api-key-authentication) 
+to authenticate against your own Fera store/account, or 
+[Auth Token authentication](https://developers.fera.ai/docs/partners-app-authentication) to authenticate against a Fera 
+store/account that you have access to with your Fera App.
+
+You can learn more about how to obtain your API key or obtain an auth token in our [developer docs](https://developers.fera.ai).
+
+## Configuring for your own Fera store/account
+Assuming you're using the `dotenv` gem (recommended) simply set the `FERA_SECRET_KEY` env variable to your store's
+secret key, then run:
+```ruby
+Fera::API.configure(ENV['FERA_SECRET_KEY'])
+```
+
+If you're not using the `dotenv` then just run `Fera::API.configure("sk_your_secret_key")` directly.
+
+## Rails Setup
+If you're using rails the best way to configure the gem is to add the following to your `config/initializers/fera.rb`:
+
+```ruby
+Fera::API.configure(ENV['FERA_SECRET_KEY'])
+```
+(And of course set the ENV variable)
+
+## Configuring as a Fera App
+If you're building a Fera Partner App, you're going to need to authenticate like this instead:
+```ruby
+Fera::API.configure(store_auth_token) do
+  # Some code here that will run against the store which you're authenticated against
+end
+```
+`store_auth_token` is what you get after successfully completing [OAuth flow for a Fera account/store](https://developers.fera.ai/docs/partners-app-authentication)./
+
+This gem also comes with a helper class for working with an app:
+```ruby
+$fera_app = Fera::App.new(ENV['FERA_CLIENT_ID'], ENV['FERA_CLIENT_SECRET'])
+```
+We recommend assigning this to a global variable since the methods in the `Fera::App` instance won't vary from Fera 
+store/account to store/account.
+
+
+# Usage
+If you've configured the gem globally because you're only working with 1 store, you can now just call Fera models just
+like you would call a Rails model:
+```ruby
+Fera::Review.all # Returns collection of reviews.
+```
+
+
+### Partner App Usage
+If you're building an app and want to run a method against a specific store only, you can run the same code but within
+the `Fera::API` block:
+```ruby
+Fera::API.configure(store_auth_token) do
+  Fera::Review.all # Returns collection of reviews.
+end
+```
+If you're building a partner app on Ruby, you might also want to check out the [Fera OmniAuth Strategy gem](https://github.com/feracommerce/omniauth-fera)
+that will make it easy to connect our app to Fera to get an auth token and start using this API.
+
+# Examples
+## Reviews
+See https://developers.fera.ai/reference/reviews
+### List all reviews
+```ruby
+Fera::Review.all # Returns collection of reviews.
+```
+
+### List a product's reviews
+```ruby
+Fera::Review.for_product(product_id: "123") # Returns collection of reviews for product with id "123".
+```
+
+### List a customer's reviews
+```ruby
+Fera::Review.where(customer_id: "123")
+```
+
+### Create a review
+```ruby
+Fera::Review.create(
+  product_id: "123",
+  rating: 5,
+  body: "This is a great product!"
+)
+```
+
+### Retrieve specific review
+```ruby
+Fera::Review.find("frev_abc123") # Returns review with id "frev_abc123".
+```
+
+### Update review
+```ruby
+review.update(body: "This is a new review body")
+# OR:
+review.body = "This is a new review body"
+review.save!
+```
+
+### Delete review
+```ruby
+review.destroy!
+```
+
+
+## Photos and Videos (Media)
+A media object may either be a photo or a video.
+
+See https://developers.fera.ai/reference/media
+
+### List all photos and videos
+```ruby
+Fera::Media.all # Returns collection of reviews.
+```
+
+### List a product's photos and videos
+```ruby
+Fera::Media.for_product(product_id: "123") # Returns collection of reviews for product with id "123".
+```
+
+### Create photo
+```ruby
+Fera::Photo.create(
+  product_id: "123",
+  file: "path/to/file",
+  caption: "This is my photo."
+)
+```
+
+### Create video
+```ruby
+Fera::Video.create(
+  product_id: "123",
+  file: "path/to/file",
+  caption: "This is my video."
+)
+```
+
+### Retrieve specific photo or video
+```ruby
+media = Fera::Media.find("fmed_abc123") # Returns photo or video with id "frev_abc123".
+puts "URL to #{ media.is_photo? ? 'photo' : 'video' }: #{ media.url }"
+```
+
+### Update photo or video
+```ruby
+media.update(caption: "This is a new media caption")
+# OR:
+media.caption = "This is a new media caption"
+media.save!
+```
+
+### Delete photo or video
+```ruby
+media.destroy!
+```
+
+
+## Customers
+See https://developers.fera.ai/reference/customers
+
+### List all customers
+```ruby
+Fera::Customer.all # Returns collection of customers.
+```
+
+### Create customer
+```ruby
+Fera::Customer.create(
+  name: "Michael Bluth",
+  email: "michael.bluth@example.com",
+  external_id: "shopify_customer_1234"
+)
+```
+
+### Retrieve specific customer
+```ruby
+Fera::Customer.find("fcus_abc123") # Returns customer with id "fcus_abc123".
+```
+
+### Update customer
+```ruby
+customer.update(name: "Tobias Funke")
+# OR:
+customer.name = "Tobias Funke"
+customer.save!
+```
+
+### Delete customer
+```ruby
+customer.destroy!
+```
+
+## Ratings
+See https://developers.fera.ai/reference/ratings
+
+### Retrieve a specific product's rating
+```ruby
+rating = Fera::Rating.for_product("product_id_1")
+puts "Product has #{ rating.count } reviews with an average rating of #{ rating.average }/5."
+```
+
+### List a list of product ratings
+```ruby
+Fera::Rating.for_products(["product_id_1", "product_id_2", "product_id_3"]) # Returns collection of ratings for product with id "123".
+```
+
+### Retrieve the store's overall rating
+```ruby
+rating = Fera::Rating.for_store
+puts "This store is rated #{ rating.average }/5 on average by #{ rating.count } customer(s)."
+```
+
+
+## Other resources to check out
+You can use some of the other resources the same way:
+- [Webhooks](https://developers.fera.ai/reference/webhooks)
+- [Store](https://developers.fera.ai/reference/store)
+- [Products](https://developers.fera.ai/reference/products)
+
+**See our [developer API reference](https://developers.fera.ai/reference) for all filters, methods and options.**
+
+# Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/feracommerce/fera-api-ruby.
+
+
+### How to contribute
+To contribute to the repository:
+
+1. Fork the repository.
+2. Clone the forked repository locally.
+3. Create a branch descriptive of your work. For example "my_new_feature_xyz".
+4. When you're done work, push up that branch to **your own forked repository** (not the main one).
+5. Visit https://github.com/feracommerce/fera-api-ruby and you'll see an option to create a pull request from your forked branch to the master. Create a pull request.
+
+
+# License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]