testrail_api 0.1.1 → 1.0.0

data/lib/testrail_api/client.rb

@@ -1,4 +1,7 @@
-require 'testrail_api/endpoints'
+require 'core_ext/array'
+
+require 'testrail_api/api'
+require 'testrail_api/default'
 require 'testrail_api/version'
 
 require 'typhoeus'
@@ -6,26 +9,32 @@ require 'json'
 
 module TestRail
   class Client
-    attr_accessor :server
-    attr_accessor :username, :password
-    attr_accessor :verbose
+    include API
+
+    attr_reader :server, :email, :password
 
     # @param server [String] TestRail server host
     # @param email [String] TestRail email
     # @param password [String] TestRail password or API key
-    # @param opts [Hash] Optional parameters
-    # @option opts [Boolean] :verbose Print libcurl debug output to the console (STDERR) if true (default : false)
-    # @option opts [Boolean] :secure Use HTTPS if true (default: true)
-    def initialize(server, email, password, opts = {})
+    # @option [Boolean] :secure   Use HTTPS if true (default: true)
+    # @option [Boolean] :verbose  Print libcurl debug output to the console (STDERR) if true (default : false)
+    def initialize(server, email, password, secure: true, verbose: false)
       # required
-      @server                  = server
-      @username                = email
-      @password                = password
+      @server      = server
+      @email       = email
+      @password    = password
 
       # optional
-      @verbose                 = opts.fetch(:verbose, false)
-      @secure                  = opts.fetch(:secure, true)
-      Typhoeus::Config.verbose = verbose
+      @secure      = secure
+      self.verbose = verbose
+    end
+
+    def verbose=(bool)
+      Typhoeus::Config.verbose = bool
+    end
+
+    def verbose
+      Typhoeus::Config.verbose
     end
 
     def scheme
@@ -33,21 +42,13 @@ module TestRail
     end
 
     def api_endpoint
-      @api_endpoint ||= File.join("#{scheme}://#{@server}", 'index.php?api/v2') if @server
+      @api_endpoint ||= File.join("#{scheme}://#{@server}", 'index.php?api/v2')
     end
 
     def user_agent
       @user_agent ||= "TestRail API v2 Gem #{VERSION}"
     end
 
-    def default_headers
-      @default_headers ||= {
-          'Accept'       => 'application/json',
-          'Content-Type' => 'application/json',
-          'User-Agent'   => user_agent
-      }
-    end
-
     def get(path, opts = {})
       request(:get, path, opts)
     end
@@ -56,12 +57,17 @@ module TestRail
       request(:post, path, opts)
     end
 
+    def credentials
+      "#{@email}:#{@password}"
+    end
+
     def request(method, path, opts = {})
       body = Typhoeus::Request.new(
           File.join(api_endpoint, path),
           { method:  method,
-            headers: default_headers,
-            userpwd: "#{@username}:#{@password}" }.merge(opts)
+            headers: Default::HEADERS,
+            userpwd: credentials
+          }.merge(opts)
       ).run.body
       JSON.parse(body)
     rescue JSON::ParserError

data/lib/testrail_api/default.rb

@@ -0,0 +1,16 @@
+module TestRail
+  module Default
+    # Default User-Agent header
+    USER_AGENT ||= "TestRail API Ruby Gem #{TestRail::VERSION}".freeze
+
+    # Default media type
+    MEDIA_TYPE ||= 'application/json'.freeze
+
+    # Default headers
+    HEADERS    ||= {
+        'Content-Type' => MEDIA_TYPE,
+        # 'Accept'       => MEDIA_TYPE,
+        'User-Agent'   => USER_AGENT
+    }.freeze
+  end
+end

data/lib/testrail_api/version.rb

@@ -1,3 +1,3 @@
 module TestRail
-  VERSION = '0.1.1'.freeze
+  VERSION ||= '1.0.0'.freeze
 end

data/testrail_api.gemspec

@@ -10,10 +10,9 @@ Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
 
   spec.authors = ['Kirill Zhukov']
-  spec.email   = ['zhukov.kirill.96@gmail.com']
 
-  spec.summary     = 'Client for TestRail API v2'
-  spec.description = 'Wrapper for TestRail API v2'
+  spec.summary     = 'Ruby client for TestRail API v2'
+  spec.description = spec.summary
   spec.homepage    = 'https://github.com/kirillzh/testrail_api'
   spec.license     = 'MIT'
 
@@ -24,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency('bundler', '~> 1.10')
   spec.add_development_dependency('rake', '~> 10.0')
 
-  spec.add_dependency('typhoeus', '~> 0.7.2')
+  spec.add_dependency('typhoeus', '~> 0.7.0')
 
   spec.required_ruby_version     = '>= 1.9.2'
   spec.required_rubygems_version = '>= 1.3.5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrail_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kirill Zhukov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,17 +44,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
-description: Wrapper for TestRail API v2
-email:
-- zhukov.kirill.96@gmail.com
+        version: 0.7.0
+description: Ruby client for TestRail API v2
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -65,7 +64,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/core_ext/array.rb
+- lib/core_ext/array/to_list.rb
 - lib/testrail_api.rb
+- lib/testrail_api/api.rb
 - lib/testrail_api/client.rb
 - lib/testrail_api/client/case_fields.rb
 - lib/testrail_api/client/case_types.rb
@@ -82,7 +84,7 @@ files:
 - lib/testrail_api/client/suites.rb
 - lib/testrail_api/client/tests.rb
 - lib/testrail_api/client/users.rb
-- lib/testrail_api/endpoints.rb
+- lib/testrail_api/default.rb
 - lib/testrail_api/version.rb
 - testrail_api.gemspec
 homepage: https://github.com/kirillzh/testrail_api
@@ -105,9 +107,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Client for TestRail API v2
+summary: Ruby client for TestRail API v2
 test_files: []
 has_rdoc: 

data/lib/testrail_api/endpoints.rb

@@ -1,15 +0,0 @@
-require 'testrail_api/client/case_fields'
-require 'testrail_api/client/case_types'
-require 'testrail_api/client/cases'
-require 'testrail_api/client/milestones'
-require 'testrail_api/client/plans'
-require 'testrail_api/client/priorities'
-require 'testrail_api/client/projects'
-require 'testrail_api/client/result_fields'
-require 'testrail_api/client/runs'
-require 'testrail_api/client/sections'
-require 'testrail_api/client/statuses'
-require 'testrail_api/client/suites'
-require 'testrail_api/client/suites'
-require 'testrail_api/client/tests'
-require 'testrail_api/client/users'