guardian_searcher 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102bea1ce30d48d194d5a647b02e19056a5f050b183e72a56c092aff8a99b892
-  data.tar.gz: 865d25653fdec0b4d3ac1ccb71356397605bb4293ab6bdcb821090b571b2d85e
+  metadata.gz: bbf80793abdcb30ddb0acb6ff62cc97bf5d2e230881d2057e391f61c3490fa4e
+  data.tar.gz: c6df4f2b8cd92f9ba2ae7fa29ae57eb3e4ad3d2a7637176e0c1a8ec53b7f654e
 SHA512:
-  metadata.gz: 1aaa54fb01c01802fd8e4f71fc922ef517631edeba4978ee8431613fdaf46115b92bdedb76917142bf3bafe8215c8e38d9c9fe84c945471435c501f0f2b938c4
-  data.tar.gz: 5df31cf5ebd052c9a2376261a410f2f2298577c4986663832114ccb7f854f7ba50a1063415402972f2e0a6826a82c04ea1ec7606199a417aed01338d00b62032
+  metadata.gz: 6d5779ce66ac3507594a07a52db236e1c581729e8b2b05d27ff11287ef8e9dce7eb69b54a9f80298a0fc2d096d3b952f1eb8fc64d3b389713fbedfd0a8e70720
+  data.tar.gz: de83958f007a38e71bfe15d4637aa645feb2d88e370582cef5de3c4fc67a9daf720fae26bd4062e7a32ce7c6a5921aa42d8d5b57be8af8f51514ec2cd8e3fda9

data/.gitignore

@@ -6,7 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+# Ignore built gemfiles
+*.gem
 # rspec failure tracking
 Gemfile.lock
 .rspec_status
+.DS_Store

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -14,7 +16,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -40,7 +42,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   dsl.watch_spec_files_for(ruby.lib_files)
 
   # Rails files
-  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
   dsl.watch_spec_files_for(rails.app_files)
   dsl.watch_spec_files_for(rails.views)
 
@@ -69,12 +71,12 @@ guard :rspec, cmd: "bundle exec rspec" do
 end
 
 guard :bundler do
-  require 'guard/bundler'
-  require 'guard/bundler/verify'
+  require "guard/bundler"
+  require "guard/bundler/verify"
   helper = Guard::Bundler::Verify.new
 
-  files = ['Gemfile']
-  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+  files = ["Gemfile"]
+  files += Dir["*.gemspec"] if files.any? { |f| helper.uses_gemspec?(f) }
 
   # Assume files are symlinked from somewhere
   files.each { |file| watch(helper.real_path(file)) }

data/README.md

@@ -26,7 +26,36 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  # To include the gem in your code
+  require 'guardian_searcher'
+
+  # To initialise the gem
+  searcher = GuardianSearcher::Search.new(api_key: <your-api-key>)
+
+  # Simplest usage
+  results = searcher.search('your keyword') 
+```
+
+There are some supported option that will be mapped to the api query and these are in the Options
+class
+
+```ruby
+{
+  from_date: "from-date",
+  to_date: "to-date",
+  page_size: "page-size",
+  page: "page"
+}
+```
+
+In this way your search could become something like
+
+```ruby
+results = searcher.search('your keyword', { from_date: '2022-10-01', page_size: 10 })
+```
+
+If you add something unsupported it will throw an `OptionsNotSupportedError`
 
 ## Development
 

data/guardian_searcher.gemspec

@@ -30,10 +30,11 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "faraday", "~> 2.2"
 
-  spec.add_development_dependency 'vcr', "~> 6.1"
-  spec.add_development_dependency 'guard', "~> 2.18"
-  spec.add_development_dependency 'guard-bundler', "~> 3.0"
-  spec.add_development_dependency 'guard-rspec', "~> 4.7"
+  spec.add_development_dependency "guard", "~> 2.18"
+  spec.add_development_dependency "guard-bundler", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "vcr", "~> 6.1"
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

data/lib/guardian_searcher/base.rb

@@ -3,6 +3,7 @@
 module GuardianSearcher
   class Base
     include Faraday
+
     attr_reader :api_key
     attr_accessor :base_uri
 
@@ -31,12 +32,7 @@ module GuardianSearcher
     private
 
     def build_options(options)
-      return {} if options.empty?
-
-      opt = ""
-      options.each do |key, value|
-        opt += "&#{key}=#{value}"
-      end
+      Options.new(options).build_options
     end
   end
 end

data/lib/guardian_searcher/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GuardianSearcher
   class OptionsNotHashError < StandardError; end
   class OptionsNotSupportedError < StandardError; end
@@ -6,13 +8,38 @@ module GuardianSearcher
     private attr_accessor :options
 
     def method_missing(method_name, *args, &blk)
-      return self.options.[](method_name, &blk) if @options.has_key?(method_name)
+      return options.[](method_name, &blk) if @options.key?(method_name)
+
       super(method_name, *args, &blk)
     end
-    
+
     def initialize(options)
       raise OptionsNotHashError unless options.is_a?(Hash)
+
       @options = options
     end
+
+    def build_options
+      return {} if options.empty?
+
+      opt = ""
+      options.each do |key, value|
+        valid_option?(key)
+        opt += "&#{map_option(key)}=#{value}"
+      end
+    end
+
+    def valid_option?(option)
+      raise OptionsNotSupportedError unless %i[from_date to_date page_size page].include?(option)
+    end
+
+    def map_option(key)
+      {
+        from_date: "from-date",
+        to_date: "to-date",
+        page_size: "page-size",
+        page: "page"
+      }[key]
+    end
   end
 end

data/lib/guardian_searcher/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guardian_searcher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alain Mauri
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -25,61 +25,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '2.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '2.18'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.18'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '0.21'
+- !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'
 description:
 email: wildeng@hotmail.com
 executables: []