pdc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75e51486f499cbbb02b2bbd086e4afafa4bd55dc
-  data.tar.gz: a134eedc49ae661ba3c7edb44ebdf5707ad111b1
+  metadata.gz: 234203e23bbe2f53796496c2048352e4029c6821
+  data.tar.gz: cd1c02de0fe5905a7312dc5f843b7ca7cc2986a9
 SHA512:
-  metadata.gz: 5b7face60ca16ecaeeed911fab646b5d5290705502ea0db5b6df117afca97b97e0abd1b2b6af12dba9f02bbcb90cadc3f188030ecea947c35c81522d3cc608ae
-  data.tar.gz: d8cb2c53473525966c40b15c57c9cec48e136b4bd0569d5b3b7123204e4182c6b57a3eccfa8daabd7760810623809e5fe8c54c94bb655f1a5741e5dc80e44716
+  metadata.gz: a85cc7e23ec88086c115e4071de94266f327ffdb05044205cf469b1c46e9aced707bfc21ab64c642136d59fd5b617e20ff2a6e2569c4e6262eaf8c0816982d0b
+  data.tar.gz: 1f31b025816cebc99da89a81dd768a7fd9741ebcac826f69ced6b2a0a6f27093b0215fd81ff3be743321ea56bdf4fc96b162562e57b0cc89cf60cefbd84a491d

data/README.md

@@ -1,8 +1,6 @@
 # PDC
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/pdc`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby `PDC` library that maps `PDC` json api to ActiveRecord like objects.
 
 ## Installation
 
@@ -26,16 +24,37 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests. You can also 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`. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 tags, and push the `.gem` file to [rubygems][]
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pdc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+[product-definition-center/pdc-ruby-gem][pdc-github] . This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant][coc] code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][mit-license]
+
+## Credits
+
+This gem is heavily influenced by the [spyke][] gem which requires
+`activesupport 4.0` or above where as the `pdc` gem needs to run against
+`activesupport 3.2.22`. If you are using `activesupport 4` (rails 4) or above
+and is looking for json api to ORM framework please consider using [spyke][] instead.
+
 
+[rubygems]: https://rubygems.org
+[mit-license]: http://opensource.org/licenses/MIT
+[coc]: http://contributor-covenant.org
+[pdc-github]: https://github.com/product-definition-center/pdc-ruby-gem
+[spyke]: https://github.com/balvig/spyke

data/examples/http_failures.rb

@@ -14,5 +14,5 @@ begin
   release.to_a
 rescue PDC::Error::ResourceNotFound => e
   ap e
-  puts "Got resource not found as expected: #{e.response[:status]}".yellowish
+  puts "Got resource not found as expected: #{e.response[:status]}"
 end

data/examples/pdc_resource_tests.rb

@@ -7,9 +7,9 @@ WebMock.disable! # this uses real server
 def token
   script_path = File.expand_path(File.dirname(__FILE__))
   token_path = File.join(script_path, '.token', 'pdc.prod')
-  File.read(token_path).chomp.tap { |x| puts "Using token :#{x.ai}" }
+  File.read(token_path).chomp.tap { |x| puts "Using token :#{x}" }
 rescue Errno::ENOENT => e
-  puts "Hey! did you forget to create #{token_path.ai} \n".red
+  puts "Hey! did you forget to create #{token_path} \n"
   raise e
 end
 

data/examples/pdc_test_cache.rb

@@ -13,7 +13,7 @@ end
 
 ActiveSupport::Notifications.subscribe "http_cache.faraday" do |*args|
   event = ActiveSupport::Notifications::Event.new(*args)
-  puts " >>> ".yellow + "cache: #{event.payload[:cache_status]}"
+  puts " >>> " + "cache: #{event.payload[:cache_status]}"
   ap event.payload
 end
 
@@ -23,8 +23,8 @@ def benchmark(description, opts = {}, &block)
   initial = Benchmark.measure(&block)
   repeat = Benchmark.measure(&block)
 
-  puts "Initial :  #{initial.to_s.chomp} >> #{initial.real.round(2).ai}"
-  puts "Repeat  :  #{repeat.to_s.chomp} >> #{repeat.real.round(2).ai} \n"
+  puts "Initial :  #{initial.to_s.chomp} >> #{initial.real.round(2)}"
+  puts "Repeat  :  #{repeat.to_s.chomp} >> #{repeat.real.round(2)} \n"
 end
 
 def main

data/examples/prod_failures.rb

@@ -18,7 +18,7 @@ def main
     ap resources
   rescue PDC::ResourceNotFound => e
     ap e
-    puts "Got resource not found as expected: #{e.response.status}".yellowish
+    puts "Got resource not found as expected: #{e.response.status}"
     ap e.message
   end
 end

data/lib/pdc/config.rb

@@ -1,5 +1,5 @@
 require 'faraday-http-cache'
-require 'curb'
+require 'pdc/http/request/token_fetcher'
 
 module PDC
   # This class is the main access point for all PDC::Resource instances.
@@ -90,7 +90,7 @@ module PDC
     end
 
     def token
-      config.token || fetch_token
+      config.token || Request::TokenFetcher.fetch(token_url)
     end
 
     private
@@ -107,10 +107,16 @@ module PDC
 
       # resets and returns the +Faraday+ +connection+ object
       def reset_base_connection
-        headers = PDC::Request.default_headers
-        PDC::Base.connection = Faraday.new(url: api_url, headers: headers) do |c|
+
+        faraday_config = {
+          url:      api_url,
+          headers:  PDC::Request.default_headers,
+          ssl:      ssl_config
+        }
+
+        PDC::Base.connection = Faraday.new(faraday_config) do |c|
           c.request   :append_slash_to_path
-          c.request   :authorization, 'Token', token if config.requires_token
+          c.request   :pdc_token, token: config.token, token_url: token_url if config.requires_token
 
           c.response  :logger, config.logger
           c.response  :pdc_paginator
@@ -129,29 +135,13 @@ module PDC
         end
       end
 
+      def ssl_config
+        { verify: config.ssl_verify_mode == OpenSSL::SSL::VERIFY_PEER }
+      end
+
       def cache_store
         config.cache_store || ActiveSupport::Cache.lookup_store(:memory_store)
       end
 
-      def fetch_token
-        curl = Curl::Easy.new(token_url.to_s) do |request|
-          request.headers['Accept'] = 'application/json'
-          request.http_auth_types = :gssnegotiate
-
-          # The curl man page (http://curl.haxx.se/docs/manpage.html)
-          # specifes setting a fake username when using Negotiate auth,
-          # and use ':' in their example.
-          request.username = ':'
-        end
-        curl.perform
-        if curl.response_code != 200
-          logger.info "Obtain token from #{token_url} failed: #{curl.body_str}"
-          error = { token_url: token_url, body: curl.body, code: curl.response_code }
-          raise PDC::TokenFetchFailed, error
-        end
-        result = JSON.parse(curl.body_str)
-        curl.close
-        result['token']
-      end
   end
 end

data/lib/pdc/http/request/append_slash.rb

@@ -5,14 +5,14 @@ module PDC
     Faraday::Request.register_middleware :append_slash_to_path => self
 
     def call(env)
-      logger.debug "\n..... append slash ..........................................".green
+      logger.debug "\n..... append slash .........................................."
       logger.debug self.class
       logger.debug env.url
 
       path = env.url.path
       env.url.path = path + '/' unless path.ends_with?('/')
 
-      logger.debug "...  after adding / #{env.url.path}: #{env.url.ai}"
+      logger.debug "...  after adding / #{env.url.path}: #{env.url}"
       @app.call(env)
     end
   end

data/lib/pdc/http/request/pdc_token.rb

@@ -0,0 +1,30 @@
+module PDC::Request
+
+  # Adds TokenAuthentication to request header. Uses the token if passed
+  # else fetches token using the TokenFetcher to get the token once
+  class Token < Faraday::Middleware
+    include PDC::Logging
+
+    Faraday::Request.register_middleware pdc_token: self
+
+    def initialize(app, options = {})
+      @options = options
+      super(app)
+    end
+
+    def call(env)
+      env.request_headers['Token'] = token
+      logger.debug "Token set, headers: #{env.request_headers}"
+      @app.call(env)
+    end
+
+    private
+
+      attr_reader :options
+
+      # uses the token passed or fetches one only once
+      def token
+        @token ||= options[:token] || TokenFetcher.fetch(options[:token_url])
+      end
+  end
+end

data/lib/pdc/http/request/token_fetcher.rb

@@ -0,0 +1,32 @@
+require 'curb'
+require 'json'
+
+module PDC::Request
+  module TokenFetcher
+
+    # uses kerberos token to obtain token from pdc
+    def self.fetch(token_url)
+      PDC.logger.debug  "Fetch token from: #{token_url}"
+      curl = Curl::Easy.new(token_url.to_s) do |request|
+        request.headers['Accept'] = 'application/json'
+        request.http_auth_types = :gssnegotiate
+
+        # The curl man page (http://curl.haxx.se/docs/manpage.html)
+        # specifes setting a fake username when using Negotiate auth,
+        # and use ':' in their example.
+        request.username = ':'
+      end
+
+      curl.perform
+      if curl.response_code != 200
+        PDC.logger.info "Obtain token from #{token_url} failed: #{curl.body_str}"
+        error = { token_url: token_url, body: curl.body, code: curl.response_code }
+        raise PDC::TokenFetchFailed, error
+      end
+      result = JSON.parse(curl.body_str)
+      curl.close
+      result['token']
+    end
+
+  end
+end

data/lib/pdc/http/request.rb

@@ -1,4 +1,6 @@
+require 'pdc/http/request/token_fetcher'
 require 'pdc/http/request/append_slash'
+require 'pdc/http/request/pdc_token'
 
 module PDC
   module Request

data/lib/pdc/http/response/pagination.rb

@@ -5,7 +5,7 @@ module PDC::Response
     Faraday::Response.register_middleware :pdc_paginator => self
 
     def parse(json)
-      logger.debug "\n.....paginate json .....................................".redish
+      logger.debug "\n.....paginate json ....................................."
 
       metadata = json[:metadata]
       logger.debug metadata
@@ -21,7 +21,7 @@ module PDC::Response
         previous_page:    request_uri(metadata.delete(:previous)),
       }
 
-      logger.debug '... after parsing pagination data:'.green
+      logger.debug '... after parsing pagination data:'
       logger.debug metadata
       json
     end

data/lib/pdc/http/response/parser.rb

@@ -8,10 +8,10 @@ module PDC::Response
     Faraday::Response.register_middleware :pdc_json_parser => self
 
     def parse(body)
-      logger.debug "\n.....parse to json .....................................".yellow
+      logger.debug "\n.....parse to json ....................................."
       logger.debug self.class
 
-      logger.debug "... parsing #{body.ai.truncate(55)}"
+      logger.debug '... parsing' +  body.to_s.truncate(55)
       begin
         json = MultiJson.load(body, symbolize_keys: true)
       rescue MultiJson::ParseError => e

data/lib/pdc/resource/rest_api.rb

@@ -8,7 +8,7 @@ module PDC::Resource
 
     module ClassMethods
       def request(method, path, query = {})
-        PDC.logger.debug '  >>>'.yellow + " : #{path.ai} #{query.ai}"
+        PDC.logger.debug '  >>>' + " : #{path} #{query}"
         ActiveSupport::Notifications.instrument('request.pdc', method: method) do |payload|
           response = connection.send(method) do |request|
             request.url path, query

data/lib/pdc/version.rb

@@ -1,3 +1,3 @@
 module PDC
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/pdc.rb

@@ -17,9 +17,4 @@ module PDC
   require 'pdc/config'
   require 'pdc/base'
   require 'pdc/v1'
-
-  # TODO: delete debug gems
-  require 'ap'
-  require 'pry'
-
 end

data/pdc.gemspec

@@ -6,8 +6,8 @@ require 'pdc/version'
 Gem::Specification.new do |s|
   s.name          = 'pdc'
   s.version       = PDC::VERSION
-  s.authors       = ['Sunil Thaha']
-  s.email         = ['sthaha@redhat.com']
+  s.authors       = ['Sunil Thaha', 'Cheng Yu']
+  s.email         = ['sthaha@redhat.com', 'ycheng@redhat.com']
 
   s.summary       = 'Ruby gem for use with Product-Definition-Center'
   s.description   = 'API for PDC'

data/spec/pdc/config_spec.rb

@@ -10,11 +10,16 @@ describe PDC do
 
   describe '##configure' do
     let(:site) { 'https://pdc.production.site.org' }
+
     let(:token_url) do
       pdc = PDC.config
       URI.join(site, pdc.api_root, pdc.token_obtain_path)
     end
 
+    let(:releases_url) do
+      URI.join(site, PDC.config.api_root, 'v1/releases/')
+    end
+
     it 'wont accept invalid config' do
       assert_raises PDC::ConfigError do
         PDC.configure do |config|
@@ -31,24 +36,38 @@ describe PDC do
       ret.must_be_instance_of Faraday::Connection
     end
 
-    it 'fetches token by default' do
-      endpoint = stub_request(:get, token_url).to_return_json(token: 'foobar')
+    it 'must not fetch token during configure step' do
+      token = stub_request(:get, token_url).to_return_json(token: 'foobar')
+      PDC.configure { |pdc| pdc.site = site }
+
+      assert_not_requested token
+    end
+
+    it 'fetches token on first request' do
+      token = stub_request(:get, token_url).to_return_json(token: 'foobar')
+
       PDC.configure { |pdc| pdc.site = site }
+      assert_not_requested token
 
-      assert_requested endpoint
-      PDC.token.must_equal 'foobar'
+      releases = stub_request(:get, releases_url).to_return_json(count: 0)
+      3.times { PDC::V1::Release.count }
+
+      # the releases will be requested n times but the token will be reused
+      assert_requested token, times: 1
+      assert_requested releases, times: 3
     end
 
     it 'raises TokenFetchFailed when fails' do
-      endpoint = stub_request(:get, token_url).to_return_json(
+      token = stub_request(:get, token_url).to_return_json(
         { detail: 'Not found' },
         status: [404, 'NOT FOUND']
       )
 
+      PDC.configure { |pdc| pdc.site = site }
       assert_raises PDC::TokenFetchFailed do
-        PDC.configure { |pdc| pdc.site = site }
+        PDC.token
       end
-      assert_requested endpoint
+      assert_requested token
     end
   end
 

data/spec/support/webmock.rb

@@ -13,7 +13,7 @@ end
 WebMock.allow_net_connect!
 
 WebMock.stub_request(:any, /.*/).to_return do |request|
-  puts "UNSTUBBED REQUEST:".red + " #{request.method.upcase} #{request.uri}"
+  puts "UNSTUBBED REQUEST:" + " #{request.method.upcase} #{request.uri}"
   { body: nil }
 end
 
@@ -22,7 +22,7 @@ module PDC
     module WebMockExtentions
       def stub_get(path)
         uri = URI.join(Fixtures::Base::SITE, 'fixtures/', path).to_s
-        puts "    stubbing: #{uri.ai}"
+        puts "    stubbing: #{uri}"
         stub_request(:get, uri)
       end
     end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pdc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sunil Thaha
+- Cheng Yu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -125,6 +126,7 @@ dependencies:
 description: API for PDC
 email:
 - sthaha@redhat.com
+- ycheng@redhat.com
 executables:
 - console
 - setup
@@ -169,6 +171,8 @@ files:
 - lib/pdc/http/errors.rb
 - lib/pdc/http/request.rb
 - lib/pdc/http/request/append_slash.rb
+- lib/pdc/http/request/pdc_token.rb
+- lib/pdc/http/request/token_fetcher.rb
 - lib/pdc/http/response.rb
 - lib/pdc/http/response/pagination.rb
 - lib/pdc/http/response/parser.rb
@@ -254,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby gem for use with Product-Definition-Center