Wip v2

.env.template → .env.development.template

@@ -1,3 +1,2 @@
 CLIENT_ID=""
 CLIENT_SECRET=""
-SHOP_URL=""

.env.test.template

@@ -0,0 +1,4 @@
+API_URL=""
+CLIENT_ID=""
+CLIENT_SECRET=""
+REFRESH_TOKEN=""

.gitignore

@@ -11,7 +11,8 @@
 .rspec_status
 
 # Environment variables
-.env
+.env*
+!.env.*.template
 
 # Apple file system
 .DS_Store

README.md

@@ -57,8 +57,9 @@ $ gem install beyond_api
 API methods can be accessed through the client instance methods. This gem supports the various authentication methods supported by the ePages API.
 
 ```ruby
-# Initializing the client
-client = BeyondApi::Token.new(api_url: 'https://team42.beyondshop.cloud/api', client_id: '<YOUR_CLIENT_ID>', client_secret: '<YOUR_CLIENT_SECRET>')
+# Client for authentication
+api_url = '<YOUR_SHOP_URL>/api'
+client = BeyondApi::Authentication::Token.new(api_url:)
 ```
 ## Generate a token from [client credentials](https://developer.epages.com/beyond-docs/#create_a_jsonwebtoken_from_client_credentials)
 
@@ -71,30 +72,56 @@ client = client.client_credentials
 ## Generate a token from [authorization code](https://developer.epages.com/beyond-docs/#create_a_jsonwebtoken_from_authorization_code)
 
 ```ruby
-client = client.get('1nBfq_')
+client = client.get('<YOUR_AUTH_CODE>')
 
 # => {:access_token=>  "<YOUR_ACCESS_TOKEN>", :token_type=>"bearer", :refresh_token=> "<YOUR_REFRESH_TOKEN>", :expires_in=>3599, :scope=> "orde:r prat:dcur pypr:cur prod:urdc", :tenant_id=>1147, :iat=>1723453179, :jti=>"C0N0VYQUgzchp2GGo8WaINhpM8s="}
 ```
 
 ## Generate a token from [refresh token](https://developer.epages.com/beyond-docs/#create_a_jsonwebtoken_from_refresh_token)
 
 ```ruby
-client = client.refresh_token('<YOUR_REFRESH_TOKEN>')
+# Client for authentication
+api_url = '<YOUR_SHOP_URL>/api'
+refresh_token = '<YOUR_REFRESH_TOKEN>'
+client = BeyondApi::Authentication::Token.new(api_url:)
 
-# => {:access_token=>  "<YOUR_ACCESS_TOKEN>", :token_type=>"bearer", :refresh_token=> "<YOUR_REFRESH_TOKEN>", :expires_in=>3599, :scope=> "orde:r prat:dcur pypr:cur prod:urdc lcnt:u pymt:ur loca:urcd sctg:m shat:cdru rfpr:ur prad:rcd", :tenant_id=>1147, :iat=>1723453179, :jti=>"C0N0VYQUgzchp2GGo8WaINhpM8s="}
+client.refresh(refresh_token)
+
+# => {:access_token=>  "<NEW_ACCESS_TOKEN>", :token_type=>"bearer", :refresh_token=> "<NEW_REFRESH_TOKEN>", :expires_in=>3599, :scope=> "orde:r prat:dcur pypr:cur prod:urdc lcnt:u pymt:ur loca:urcd sctg:m shat:cdru rfpr:ur prad:rcd", :tenant_id=>1147, :iat=>1723453179, :jti=>"C0N0VYQUgzchp2GGo8WaINhpM8s="}
 ```
 
 ## Making requests
 
 After generating your token following the instructions above, you can start using this gem to access various resources available, including categories, products, orders, webhooks, and more.
 
 ```ruby
-client = BeyondApi::ProductManagement::Category.new(api_url: ENV["API_URL"], access_token: '<YOUR_ACCESS_TOKEN>')
-
-# Retrieve all categories
-client.all
+# Define the API URL and access token
+api_url = '<YOUR_SHOP_URL>/api'
+access_token = '<YOUR_ACCESS_TOKEN>'
+
+# Create a new client instance for category management
+client = BeyondApi::ProductManagement::Category.new(api_url:, access_token:)
+
+# Find a specific category by its ID
+client.find('category-id')
+
+# The response is a hash representing the category details:
+# => {
+#      :id=>"8a4a8f6a-e3d9-4616-9e89-12c42c084534",
+#      :name=>"DO-NOT-DELETE Category",
+#      :type=>"SMART",
+#      :default_sort=>"HIGHEST_PRICE_FIRST",
+#      :filters=>[],
+#      :links=>{
+#        :self=>{
+#          :href=>"https://team42-beyond-api.beyondshop.cloud/api/categories/8a4a8f6a-e3d9-4616-9e89-12c42c084534"
+#        },
+#        :category=>{
+#          :href=>"https://team42-beyond-api.beyondshop.cloud/api/categories/8a4a8f6a-e3d9-4616-9e89-12c42c084534"
+#        }
+#      }
+#    }
 
-# =>  {:embedded=>{:categories=>[{:id=>"539c1671-1540-4254-adaf-8b22b188d6d2", :name=>"New Category", :type=>"SMART", :default_sort=>"HIGHEST_PRICE_FIRST", :filters=>[], :links=>  {:self=>{:href=>"https://team42.beyondshop.cloud/api/categories/539c1671-1540-4254-adaf-8b22b188d6d2"}, :category=>{:href=>"https://team42.beyondshop.cloud/api/categories/539c1671-1540-4254-adaf-8b22b188d6d2"}}}]}, :links=>{:self=>{:href=>"https://team42.beyondshop.cloud/api/categories?page=0&size=20"}}, :page=>{:size=>20, :total_elements=>9, :total_pages=>1, :number=>0}}
 ```
 
 ## Documentation
@@ -103,10 +130,14 @@ See [GETTING_STARTED](https://github.com/ePages-de/beyond_api-ruby_client/blob/m
 
 ## Development
 
-Check out the repo an 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.
+Check out the repo an run `bin/setup` to install dependencies. Rename the file `.env.development.template` to `.env.development` and fill in the necessary information. Then, you can run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+## Test
+
+Rename the file `.env.test.template` to `.env.test` and fill in the necessary information. Then, run `rspec` to run the tests.
+
 ## Contributing
 
 Please see [CONTRIBUTING](https://github.com/ePages-de/beyond_api-ruby_client/blob/master/CONTRIBUTING.md).

bin/console

@@ -4,13 +4,13 @@
 require "bundler/setup"
 require "dotenv/load"
 require "beyond_api"
+require "pry"
+
+Dotenv.load('.env.development')
 
-unless ENV["CLIENT_ID"].nil? && ENV["CLIENT_SECRET"].nil?
-  BeyondApi.setup do |config|
-    config.client_id = ENV["CLIENT_ID"]
-    config.client_secret = ENV["CLIENT_SECRET"]
-  end
+BeyondApi.setup do |config|
+  config.client_id = ENV.fetch("CLIENT_ID", nil)
+  config.client_secret = ENV.fetch("CLIENT_SECRET", nil)
 end
 
-require "pry"
 Pry.start

lib/beyond_api/concerns/connection.rb

@@ -43,7 +43,7 @@ def parse_request(hash)
       def handle_request
         Response.new(yield).parse
       rescue Faraday::TimeoutError, Faraday::ConnectionFailed => e
-        raise FaradayError, e
+        raise BeyondApi::FaradayError, e
       end
 
       def agent

lib/beyond_api/error.rb

@@ -10,6 +10,4 @@ def initialize(response)
       super
     end
   end
-
-  class FaradayError < Error; end
 end

lib/beyond_api/faraday_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BeyondApi
+  class FaradayError < Error; end
+end