act_as_api_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f1c7c6c3d7211351b1bd796c0f246656d4cf5e860c586d88a52da0c133b8622
-  data.tar.gz: 525403634a6f733f4ef1729b8bbc7dc4d30087029eefb8aecfe025642ed518d1
+  metadata.gz: 2872e7e3132a079bc57e2143b28a3898b18145033cde50bb6375c29400e91b38
+  data.tar.gz: 186709908bdf7221b87e8c12879843bb0ebe03ab87741cb1d9af562a1aebe057
 SHA512:
-  metadata.gz: '028bb21fa8d582e88781684576b07878a00bdef6b556de591bd23a3c3fbf43be12a71f673a55d189f49ca45accb94bfbc86ff2d90a31a9b84bb35c354f0ffb59'
-  data.tar.gz: b5769d9b5db7fafb4cf7b4cf2ee9a98278154ad1536ddb83be48634f81085c4ee84de16daa1172e6000bf7602710519012efd9ebf115e46094687e39b813318a
+  metadata.gz: 00443a970f37aebf5b33cf1e32c6ff3f7dc9fafeef5cd1e36ec1e102ca2d856088dd152ea327a13628c715fc7bf187979b3183bf290b3aee5c46a264354df37d
+  data.tar.gz: a0781851c2b72663c7e930a3504e2b828a4e894cebf4bd65810f49ca361ada94c193959af25fa43d68ed09d8753e27207d5ffe9c025dbf3d2c9c9a9d9753e32d

data/.gitignore

@@ -12,4 +12,6 @@
 
 .idea
 .byebug_history
-spec/credentials.yml
+spec/credentials.yml
+
+*.gem

data/.rubocop.yml

@@ -15,4 +15,8 @@ Layout/LineLength:
   Max: 120
 
 AllCops:
-  NewCops: enable
+  NewCops: enable
+  TargetRubyVersion: 2.4
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,91 +1,56 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-07-04 14:26:01 UTC using RuboCop version 0.93.1.
+# on 2022-07-11 09:13:33 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'act_as_api_client.gemspec'
-
-# Offense count: 7
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'spec/act_as_api_client_spec.rb'
-    - 'spec/clients/github_client_spec.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
-Lint/UnusedMethodArgument:
+# Configuration parameters: IgnoredMethods, Max.
+Metrics/AbcSize:
   Exclude:
     - 'lib/act_as_api_client/clients/github_client.rb'
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
   Exclude:
     - '**/*.gemspec'
-    - 'spec/act_as_api_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'
+
+# 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'
 
 # Offense count: 2
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/act_as_api_client.rb'
 
-# Offense count: 1
-# Configuration parameters: Prefixes.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/act_as_api_client_spec.rb'
-
 # Offense count: 1
 # Configuration parameters: Max.
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/act_as_api_client_spec.rb'
+    - 'spec/act_as_api_client/clients/http_client_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: CustomTransform, IgnoreMethods, SpecSuffixOnly.
-RSpec/FilePath:
-  Exclude:
-    - 'spec/clients/github_client_spec.rb'
-
-# Offense count: 7
-RSpec/LeakyConstantDeclaration:
-  Exclude:
-    - 'spec/act_as_api_client_spec.rb'
-    - 'spec/clients/github_client_spec.rb'
-
-# Offense count: 5
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'demo.rb'
-    - 'lib/act_as_api_client.rb'
-    - 'lib/act_as_api_client/base_api_methods.rb'
-    - 'lib/act_as_api_client/clients/github_client.rb'
-    - 'lib/act_as_api_client/clients/http_client.rb'
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+# Offense count: 3
+# Configuration parameters: Max.
+RSpec/NestedGroups:
   Exclude:
-    - 'lib/act_as_api_client.rb'
+    - 'spec/act_as_api_client/clients/github_client/find_by_spec.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -93,4 +58,4 @@ Style/GuardClause:
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
-    - 'act_as_api_client.gemspec'
+    - 'lib/act_as_api_client/clients/github_client.rb'

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    act_as_api_client (0.1.0)
-      httparty (~> 0.20)
+    act_as_api_client (0.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -15,13 +14,6 @@ GEM
       rexml
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    multi_xml (0.6.0)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)

data/README.md

@@ -2,7 +2,7 @@
 
 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`.
 
-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](#usage) section to find how to use existing preconfigured API's and encapsulate all logic inside `APIClient` classes.
+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_   
 
@@ -24,10 +24,10 @@ Or install it yourself as:
 
 ## Usage
 
-**1. Folder for clients:**
-Create a folder for examples api_clients inside your `lib` directory.
+### 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.
 
-**2. Create API client class:**
+### Create API client class:
 For example you want to fetch and update Github repositoties, then you class may have a form like this:
 
 ```ruby
@@ -36,7 +36,7 @@ class GithubClient < ApiClient
 end
 ```
 
-In case you want to provide and use auth token for Github: 
+In case you want to provide and use authorization token for Github: 
 
 ```ruby
 class GithubClient < ApiClient
@@ -46,8 +46,17 @@ class GithubClient < ApiClient
                     }
 end
 ```
+btw, all values from `with` hash will be availabe in tour clients as instance variable `@options`
 
-btw, all values from `with` hash will be availabe in tour clients as instance variable `@options`   
+### Use it:
+Let's fetch all repositories from Rails organization:
+
+```ruby
+github_client = GithubClient.new()
+github_client.find_by(organization: 'rails')
+```
+
+Voila.
 
 ## List of supported api clients
 1. [Github Repositories](https://docs.github.com/en/rest/repos/repos)
@@ -58,14 +67,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/act_as_api_client. 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/[USERNAME]/act_as_api_client/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 ActAsApiClient project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/act_as_api_client/blob/master/CODE_OF_CONDUCT.md).

data/act_as_api_client.gemspec

@@ -9,13 +9,17 @@ Gem::Specification.new do |spec|
   spec.email         = ["rukomoynikov@gmail.com"]
 
   spec.summary       = "Collection of predefined API clients"
-  spec.description   = "Helps you to build reliable API clients in a minute. Just add act_as_api_client to your classes."
+  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.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Rukomoynikov/act_as_api_client"
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/Rukomoynikov/act_as_api_client",
+    "homepage_uri" => spec.homepage,
+    "documentation_uri" => "https://rubydoc.info/github/Rukomoynikov/act_as_api_client/main",
+    "bug_tracker_uri" => "https://github.com/Rukomoynikov/act_as_api_client/issues"
+  }
 
   # 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.
@@ -25,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "httparty", "~> 0.20"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/act_as_api_client/clients/github_client.rb

@@ -1,50 +1,94 @@
 # frozen_string_literal: true
 
 require_relative "http_client"
-require "httparty"
 
 module ActAsApiClient
   module Clients
     module GithubClient
       include HttpClient
+
+      # Searches Github for one repository by it's owner and repository names.
+      # More details look at the corresponding {https://docs.github.com/en/rest/repos/repos#get-a-repository Github Docs page}
+      #
+      # @param repository_name [String] owner and repository name, 'Rukomoynikov/tabled'
+      #
+      # @return [Hash] detailed info about the repository.
       def find(repository_name)
         unless repository_name.match?(%r{[a-zA-Z]/[a-zA-Z]})
           raise StandardError, "repository_name parameter is not valid"
         end
 
-        HTTParty
-          .get(
-            "https://api.github.com/repos/#{repository_name}",
-            headers: { "Content-Type" => "application/json",
-                       "Accept" => "application/vnd.github.v3+json",
-                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) }
-          )
-          .parsed_response
+        get("https://api.github.com/repos/#{repository_name}",
+            headers: { "Accept" => "application/vnd.github.v3+json",
+                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
       end
 
-      def where
-        "where"
+      # Search through Github repositories using query string and additional parameters explained on the {https://docs.github.com/en/rest/search#search-repositories Github Docs page}
+      #
+      # @param query_string [String] query string to search github repositories
+      # @param parameters [Hash] paramaters like per_page, page, sort and order
+      #
+      # @example Reverse a string
+      #   class GithubClient < ApiClient
+      #     act_as_api_client for: :github
+      #   end
+      #
+      #   GithubClient.new.where('rails')
+      #   GithubClient.new.where('rails', per_page: 100)
+      #
+      # @return [Array] list of repositories
+      def where(query_string, parameters = {})
+        get("https://api.github.com/search/repositories",
+            headers: { "Accept" => "application/vnd.github.v3+json",
+                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) },
+            params: { q: query_string }.merge(parameters))
       end
 
+      # Use this method if you need to get list of repositories selected by one of this conditions: user, authenticated_user, organization
+      #
+      # @param options [Hash] has to have one of these keys: user, authenticated_user, organization
+      #
+      # @example Reverse a string
+      #   class GithubClient < ApiClient
+      #     act_as_api_client for: :github
+      #   end
+      #
+      #   GithubClient.new.find_by(organization: 'rails')
+      #
+      # @return [Array] list of repositories
       def find_by(options = {})
-        # by_organization https://docs.github.com/en/rest/repos/repos#list-organization-repositories
-        # by_user https://docs.github.com/en/rest/repos/repos#list-repositories-for-a-user
-        # by_authenticated_user https://docs.github.com/en/rest/repos/repos#list-repositories-for-the-authenticated-user
-        "find_by"
-      end
+        unless options.is_a?(Hash)
+          raise StandardError, "provide a hash as an argument not #{options.class.to_s.downcase}"
+        end
+        raise StandardError, "provide at least one parameter" if options.keys.length.zero?
+        raise StandardError, "method 'find_by' supports only one parameter" if options.keys.length > 1
 
-      def delete
-        # Call only on queried before repository and repository is not 404/400 and has right to delete (write)
-        "delete"
-      end
+        url = case options.keys.first
+              when :organization
+                "https://api.github.com/orgs/#{options[:organization]}/repos"
+              when :user
+                "https://api.github.com/users/#{options[:user]}/repos"
+              when :authenticated_user
+                "https://api.github.com/repositories"
+              end
 
-      def create
-        "create"
+        get(url,
+            headers: { "Accept" => "application/vnd.github.v3+json",
+                       "Authorization" => (options[:token] ? "token #{options[:token]}" : nil) })
       end
 
-      def update
-        "update"
-      end
+      # def delete
+      #   # Call only on queried before repository and repository is not 404/400 and has right to delete (write)
+      #   "delete"
+      # end
+      #
+      # def create
+      #   "create"
+      # end
+      #
+      # def update
+      #   "update"
+      # end
     end
   end
 end

data/lib/act_as_api_client/clients/http_client.rb

@@ -1,28 +1,52 @@
 # frozen_string_literal: true
 
-require "httparty"
+require "net/http"
 
 module ActAsApiClient
   module Clients
     module HttpClient
+      private
+
       def get(url, options = {})
-        HTTParty.get(url, options).parsed_response
+        # Request part
+        uri = URI(url)
+        uri.query = URI.encode_www_form(options.fetch(:params, {}))
+
+        request = Net::HTTP::Get.new(uri)
+        request_headers(headers: options.fetch(:headers, {}),
+                        request: request)
+
+        # Response part
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        case response
+        when Net::HTTPNotFound, Net::HTTPSuccess, Net::HTTPUnprocessableEntity
+          JSON.parse(response.body)
+        end
       end
 
       def post
-        HTTParty.post
+        # HTTParty.post
       end
 
       def put
-        HTTParty.put
+        # HTTParty.put
       end
 
       def update
-        HTTParty.update
+        # HTTParty.update
       end
 
       def delete
-        HTTParty.delete
+        # HTTParty.delete
+      end
+
+      def request_headers(headers:, request:)
+        headers.each do |key, value|
+          request[key] = value
+        end
       end
     end
   end

data/lib/act_as_api_client/version.rb

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

data/lib/act_as_api_client.rb

@@ -15,11 +15,11 @@ class ApiClient
     private
 
     def set_general_client(client_for:)
-      unless client_for.nil?
-        require(File.expand_path("act_as_api_client/clients/#{client_for}_client",
-                                 File.dirname(__FILE__)))
-        include const_get("ActAsApiClient::Clients::#{client_for.capitalize}Client")
-      end
+      return if client_for.nil?
+
+      require(File.expand_path("act_as_api_client/clients/#{client_for}_client",
+                               File.dirname(__FILE__)))
+      include const_get("ActAsApiClient::Clients::#{client_for.capitalize}Client")
     end
 
     def set_options(options:)

metadata

@@ -1,31 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: act_as_api_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Max Rukomoynikov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
+date: 2022-07-11 00:00:00.000000000 Z
+dependencies: []
 description: Helps you to build reliable API clients in a minute. Just add act_as_api_client
-  to your classes.
+  to your classes
 email:
 - rukomoynikov@gmail.com
 executables: []
@@ -56,8 +42,10 @@ homepage: https://rubygems.org/gems/act_as_api_client
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://rubygems.org/gems/act_as_api_client
   source_code_uri: https://github.com/Rukomoynikov/act_as_api_client
+  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:
 rdoc_options: []
 require_paths:
@@ -66,14 +54,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Collection of predefined API clients