act_as_api_client 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 585bfe652e889c7eaebcd2dfefd0a0c295ae87a390f9522de24fc2126e9011b3
-  data.tar.gz: 5d61e33b3f9702b1bbcc2bac97913278dcbcfc6e7db780e0ea4b1a1efdfb14cb
+  metadata.gz: 2879b607f0a39fdba8f0b5c92097320aacafd5e98a23e8082f051e9b95340765
+  data.tar.gz: c694503be26586f6c184f64b1df4084d261c1dae82aede31951fe7aa023d2c10
 SHA512:
-  metadata.gz: e2cc7b10a33b1d6955b6aad98709aa58ddba78e38e7804ab6f8b4b8be49ce4ac4b93077cdfa0a9f81e6ea5501784ce02d0ff278228affb4a33a23d71ed52adbe
-  data.tar.gz: c3926de463c5fef33ce98c7158165cffe8fb19d5eef4a94b72fc14fbc51b9a0966134845d899a23310e26b786326a1fe9ee1f058390f7c19809efefa43f7b822
+  metadata.gz: 8d94a6752470991a895526ed0a371e34c44a5db3cc7c1f6d9a81a3e38c4d1ba7a3b39ab0a2406277aa407037744b60f2bbe0408197eaf6cccd625b9f80ef767d
+  data.tar.gz: fc1abaa4b3ae8541dd3a67de89d0a74035ebc8d909aab2d1d48f1d2d34b609bd8406aa28a5a864eff3402aa5a922abcfecf6169b022c9408d6eebc8620d9b65d

data/.devcontainer.json

@@ -0,0 +1,11 @@
+{
+  "dockerComposeFile": "./docker-compose.yml",
+  "service": "app",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-azuretools.vscode-docker"
+      ]
+    }
+  }
+}

data/.github/workflows/main.yml

@@ -9,9 +9,9 @@ name: Ruby
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 permissions:
   contents: read
@@ -21,7 +21,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.0']
+        ruby-version: ["3.0"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby
@@ -35,15 +35,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby
-        uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          bundler-cache: true
       - name: Copy credentials file for CI
         run: mv spec/credentials.example.yml spec/credentials.yml
       - name: Run tests
-        run: bundle exec rspec
+        run: bundle exec rspec

data/.rubocop.yml

@@ -16,7 +16,7 @@ Layout/LineLength:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 Style/Documentation:
-  Enabled: false
+  Enabled: false

data/.rubocop_todo.yml

@@ -10,61 +10,64 @@
 # Configuration parameters: IgnoredMethods, Max.
 Metrics/AbcSize:
   Exclude:
-    - 'lib/act_as_api_client/clients/github_client.rb'
+    - "lib/act_as_api_client/clients/github_repositories_client.rb"
 
 # Offense count: 5
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Exclude:
-    - '**/*.gemspec'
-    - 'spec/act_as_api_client/clients/authorize_net/authorize_net_notifications_client_spec.rb'
-    - 'spec/act_as_api_client/clients/github_client/find_by_spec.rb'
-    - 'spec/act_as_api_client/clients/github_client/find_spec.rb'
-    - 'spec/act_as_api_client/clients/github_client/where_spec.rb'
+    - "**/*.gemspec"
+    - "spec/act_as_api_client/clients/authorize_net/authorize_net_notifications_client_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/find_by_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/find_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/where_spec.rb"
 
 # Offense count: 1
 # Configuration parameters: IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
-    - 'lib/act_as_api_client/clients/github_client.rb'
+    - "lib/act_as_api_client/clients/github_repositories_client.rb"
 
 # Offense count: 2
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods.
 Metrics/MethodLength:
   Exclude:
-    - 'lib/act_as_api_client/clients/github_client.rb'
-    - 'lib/act_as_api_client/clients/http_client.rb'
+    - "lib/act_as_api_client/clients/github_repositories_client.rb"
+    - "lib/act_as_api_client/clients/http_client.rb"
 
 # Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/act_as_api_client.rb'
+    - "lib/act_as_api_client.rb"
 
 # Offense count: 1
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/act_as_api_client/clients/http_client_spec.rb'
+    - "spec/act_as_api_client/clients/http_client_spec.rb"
 
 # Offense count: 2
 # Configuration parameters: CustomTransform, IgnoreMethods, SpecSuffixOnly.
 RSpec/FilePath:
   Exclude:
-    - 'spec/act_as_api_client/clients/authorize_net/authorize_net_notifications_client_spec.rb'
-    - 'spec/act_as_api_client/clients/authorize_net/authorize_net_webhooks_client_spec.rb'
+    - "spec/act_as_api_client/clients/authorize_net/authorize_net_notifications_client_spec.rb"
+    - "spec/act_as_api_client/clients/authorize_net/authorize_net_webhooks_client_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/find_by_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/find_spec.rb"
+    - "spec/act_as_api_client/clients/github_client/where_spec.rb"
 
 # Offense count: 3
 # Configuration parameters: Max.
 RSpec/NestedGroups:
   Exclude:
-    - 'spec/act_as_api_client/clients/github_client/find_by_spec.rb'
+    - "spec/act_as_api_client/clients/github_client/find_by_spec.rb"
 
 # Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'lib/act_as_api_client/clients/authorize_net_webhooks_client.rb'
+    - "lib/act_as_api_client/clients/authorize_net_webhooks_client.rb"
 
 # Offense count: 4
 # Cop supports --auto-correct.
@@ -72,5 +75,5 @@ Style/GuardClause:
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
-    - 'lib/act_as_api_client/clients/github_client.rb'
-    - 'spec/support/vcr_setup.rb'
+    - "lib/act_as_api_client/clients/github_repositories_client.rb"
+    - "spec/support/vcr_setup.rb"

data/Dockerfile

@@ -0,0 +1,3 @@
+FROM ruby:2.6-bullseye
+COPY Gemfile Gemfile.lock act_as_api_client.gemspec .
+RUN bundle install

data/Gemfile

@@ -4,11 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in act_as_api_client.gemspec
 gemspec
-
-gem "byebug", "~> 11.1"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 0.80"
-gem "rubocop-rspec", require: false
-gem "vcr", "~> 6.1"
-gem "webmock", "~> 3.14"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    act_as_api_client (0.2.0)
+    act_as_api_client (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -71,4 +71,4 @@ DEPENDENCIES
   webmock (~> 3.14)
 
 BUNDLED WITH
-   2.2.3
+   1.17.2

data/README.md

@@ -1,11 +1,9 @@
 # act_as_api_client
 
-How to create api clients for your application? What is a better way to encapsualte interactions with third APIs? My answer is `act_as_api_client`.
+How to create api clients for your application? What is a better way to encapsualte interactions with third party APIs? My answer is `act_as_api_client`.
 
 Let's assume you have a typical Rails or any ruby application and want to play around with an API, Github for example. See the [Usage](https://github.com/Rukomoynikov/act_as_api_client#usage) section to find how to use existing preconfigured API's and encapsulate all logic inside `APIClient` classes.
 
-_At the moment i experiment in order to make api clients behavior very similiar to `ActiveRecord` models, so out of the box most of the clients support these methods: find, where, delete, update, find_by, create, update_   
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,14 +23,14 @@ Or install it yourself as:
 ## Usage
 
 ### Folder for clients:
-Create a folder in your app for examples `api_clients` inside your `lib` directory. This will be the place where you will keep all... api clients.
+Create a folder in your app for examples `api_clients`. This will be the place where you will keep all servies responsible for communication with external HTTP APIs.
 
 ### Create API client class:
-For example you want to fetch and update Github repositoties, then you class may have a form like this:
+For example, you need to fetch and update Github repositories, then you class may have a form like this:
 
 ```ruby
 class GithubClient < ApiClient
-  act_as_api_client for: :github
+  act_as_api_client for: :github_repositories
 end
 ```
 
@@ -40,9 +38,9 @@ In case you want to provide and use authorization token for Github:
 
 ```ruby
 class GithubClient < ApiClient
-  act_as_api_client for: :github,
+  act_as_api_client for: :github_repositories,
                     with: {
-                      token: <your_token>
+                      token: <your_token> # ENV variable of secret
                     }
 end
 ```

data/act_as_api_client.gemspec

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "lib/act_as_api_client/version"
-
 Gem::Specification.new do |spec|
   spec.name          = "act_as_api_client"
-  spec.version       = ActAsApiClient::VERSION
+  spec.version       = "1.0.0"
   spec.authors       = ["Max Rukomoynikov"]
   spec.email         = ["rukomoynikov@gmail.com"]
 
@@ -12,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Helps you to build reliable API clients in a minute. Just add act_as_api_client to your classes"
   spec.homepage      = "https://rubygems.org/gems/act_as_api_client"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata = {
     "source_code_uri" => "https://github.com/Rukomoynikov/act_as_api_client",
@@ -29,6 +27,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "byebug", "~> 11.1"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.80"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "vcr", "~> 6.1"
+  spec.add_development_dependency "webmock", "~> 3.14"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/demo.rb

@@ -3,7 +3,7 @@
 require_relative "lib/act_as_api_client"
 
 class GithubClient < ApiClient
-  act_as_api_client for: :github
+  act_as_api_client for: :github_repositories
 end
 
 p GithubClient.ancestors

data/docker-compose.yml

@@ -0,0 +1,9 @@
+services:
+  app:
+    build:
+      dockerfile: Dockerfile
+    working_dir: /app
+    volumes:
+      - ./:/app
+    tty: true
+    stdin_open: true

data/lib/act_as_api_client/clients/{github_client.rb → github_repositories_client.rb}

@@ -4,7 +4,7 @@ require_relative "http_client"
 
 module ActAsApiClient
   module Clients
-    module GithubClient
+    module GithubRepositoriesClient
       include HttpClient
 
       # Searches Github for one repository by it's owner and repository names.
@@ -30,7 +30,7 @@ module ActAsApiClient
       #
       # @example Reverse a string
       #   class GithubClient < ApiClient
-      #     act_as_api_client for: :github
+      #     act_as_api_client for: :github_repositories
       #   end
       #
       #   GithubClient.new.where('rails')
@@ -50,7 +50,7 @@ module ActAsApiClient
       #
       # @example Reverse a string
       #   class GithubClient < ApiClient
-      #     act_as_api_client for: :github
+      #     act_as_api_client for: :github_repositories
       #   end
       #
       #   GithubClient.new.find_by(organization: 'rails')

data/lib/act_as_api_client.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "act_as_api_client/version"
 require_relative "act_as_api_client/base_api_methods"
 
 class ApiClient

metadata

@@ -1,15 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: act_as_api_client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Max Rukomoynikov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
-dependencies: []
+date: 2024-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
 description: Helps you to build reliable API clients in a minute. Just add act_as_api_client
   to your classes
 email:
@@ -18,12 +116,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer.json"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -33,13 +133,11 @@ files:
 - bin/console
 - bin/setup
 - demo.rb
+- docker-compose.yml
 - lib/act_as_api_client.rb
 - lib/act_as_api_client/base_api_methods.rb
-- lib/act_as_api_client/clients/authorize_net_notifications_client.rb
-- lib/act_as_api_client/clients/authorize_net_webhooks_client.rb
-- lib/act_as_api_client/clients/github_client.rb
+- lib/act_as_api_client/clients/github_repositories_client.rb
 - lib/act_as_api_client/clients/http_client.rb
-- lib/act_as_api_client/version.rb
 homepage: https://rubygems.org/gems/act_as_api_client
 licenses:
 - MIT
@@ -48,7 +146,7 @@ metadata:
   homepage_uri: https://rubygems.org/gems/act_as_api_client
   documentation_uri: https://rubydoc.info/github/Rukomoynikov/act_as_api_client/main
   bug_tracker_uri: https://github.com/Rukomoynikov/act_as_api_client/issues
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -56,15 +154,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: Collection of predefined API clients
 test_files: []

data/lib/act_as_api_client/clients/authorize_net_notifications_client.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "http_client"
-require_relative "./authorize_net_webhooks_client"
-require "base64"
-
-module ActAsApiClient
-  module Clients
-    module AuthorizeNetNotificationsClient
-      include AuthorizeNetWebhooksClient
-
-      def where(parameters = {})
-        # GET https://apitest.authorize.net/rest/v1/notifications?from_date=2017-03-01&to_date=2017-03-13&offset=0&limit=100
-        # GET https://apitest.authorize.net/rest/v1/notifications?deliveryStatus=Failed
-        # [:from_date, :to_date, :offset, :limit, :deliveryStatus]
-
-        get("https://#{base_uri}/rest/v1/notifications/",
-            headers: { "Authorization" => auth },
-            params: parameters)
-      end
-
-      def find(uuid)
-        raise StandardError, "uuid is not provided" if uuid.empty?
-
-        get("https://#{base_uri}/rest/v1/notifications/#{uuid}",
-            headers: { "Authorization" => auth })
-      end
-    end
-  end
-end

data/lib/act_as_api_client/clients/authorize_net_webhooks_client.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "http_client"
-require "base64"
-
-module ActAsApiClient
-  module Clients
-    module AuthorizeNetWebhooksClient
-      include HttpClient
-      DEFAULT_OPTIONS = {
-        mode: :production
-      }.freeze
-
-      def initialize
-        @options = DEFAULT_OPTIONS.merge(options)
-      end
-
-      def find(uuid)
-        raise StandardError, "uuid is not provided" if uuid.empty?
-
-        get("https://#{base_uri}/rest/v1/webhooks/#{uuid}",
-            headers: { "Authorization" => auth })
-      end
-
-      private
-
-      def base_uri
-        if @options[:mode] == :test
-          "apitest.authorize.net"
-        else
-          "authorize.net"
-        end
-      end
-
-      def auth
-        if options[:payment_user]
-          "Basic #{Base64.strict_encode64("#{options[:payment_user]}:#{options[:payment_pass]}")}"
-        end
-      end
-    end
-  end
-end

data/lib/act_as_api_client/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module ActAsApiClient
-  VERSION = "0.2.0"
-end