crx_packmgr_api_client 0.1.0 → 1.0.0

data/lib/crx_packmgr_api_client/models/update_status.rb

@@ -0,0 +1,217 @@
+=begin
+#CRX Package Manager API
+
+#API for interacting with the CRX Package Manager in AEM.
+
+OpenAPI spec version: 6.2.0
+Contact: bryan.stopp@gmail.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require 'date'
+
+module CrxPackageManager
+
+  class UpdateStatus
+    attr_accessor :success
+
+    attr_accessor :msg
+
+    attr_accessor :path
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'success' => :'success',
+        :'msg' => :'msg',
+        :'path' => :'path'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'success' => :'BOOLEAN',
+        :'msg' => :'String',
+        :'path' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.has_key?(:'msg')
+        self.msg = attributes[:'msg']
+      end
+
+      if attributes.has_key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          success == o.success &&
+          msg == o.msg &&
+          path == o.path
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [success, msg, path].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CrxPackageManager.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/crx_packmgr_api_client/version.rb

@@ -3,7 +3,7 @@
 
 #API for interacting with the CRX Package Manager in AEM.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 6.2.0
 Contact: bryan.stopp@gmail.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -22,5 +22,5 @@ limitations under the License.
 =end
 
 module CrxPackageManager
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/spec/acceptance/default_api_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper_acceptance'
+require 'xmlsimple'
+
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    config = CrxPackageManager::Configuration.new
+    config.username = 'admin'
+    config.password = 'admin'
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  after do
+    # run after each test
+  end
+
+  let(:package) do
+    file = File.new(File.join(File.dirname(__FILE__), '..', 'files', 'test-1.0.0.zip'))
+    file
+  end
+
+  let(:path) do
+    '/etc/packages/my_packages/test-1.0.0.zip'
+  end
+
+  context 'init' do
+    it 'should work' do
+      data = @instance.init
+      expect(data).to be_a(CrxPackageManager::InitData)
+      expect(data.context_path).to eq('/crx')
+      expect(data.launchpad_context_path).to eq('/')
+      expect(data.jcr_version).to eq('2.0')
+      expect(data.workspace).to eq('crx.default')
+      expect(data.user_id).to eq('Administrator')
+      expect(data.workspaces).to eq(['crx.default'])
+    end
+  end
+
+  context 'installstatus' do
+    it 'should work' do
+      data = @instance.installstatus
+      expect(data).to be_a(CrxPackageManager::InstallStatus)
+      expect(data.status.finished).to eq(true)
+      expect(data.status.item_count).to eq(0)
+    end
+  end
+
+
+  context 'service upload and update' do
+    it 'should support cmd=help' do
+      xml = @instance.service_get('help')
+      parsed = XmlSimple.xml_in(xml, { ForceArray: %r(param), KeyToSymbol: true, AttrToSymbol: true } )
+      sr = CrxPackageManager::ServiceResponse.new
+      sr = sr.build_from_hash(parsed)
+      expect(sr.version).to eq('1.4.1')
+      expect(sr.user).to eq('admin')
+      expect(sr.workspace).to eq('crx.default')
+      expect(sr.request).not_to be_nil
+      req = sr.request
+      params = req.param
+      expect(params).to be_a(Array)
+      expect(params.length).to eq(1)
+      expect(params[0].name).to eq('cmd')
+      response = sr.response
+      expect(response.status[:code].to_i).to eq(200)
+    end
+
+    it 'should support post' do
+      xml = @instance.service_post(package)
+      parsed = XmlSimple.xml_in(xml, { ForceArray: %r(param), KeyToSymbol: true, AttrToSymbol: true } )
+      sr = CrxPackageManager::ServiceResponse.new
+      sr = sr.build_from_hash(parsed)
+      response = sr.response
+      expect(response.status[:code].to_i).to eq(200)
+    end
+
+    it 'should support install' do
+      xml = @instance.service_get('inst', name: 'test')
+      parsed = XmlSimple.xml_in(xml, { ForceArray: %r(param), KeyToSymbol: true, AttrToSymbol: true } )
+      sr = CrxPackageManager::ServiceResponse.new
+      sr = sr.build_from_hash(parsed)
+      response = sr.response
+      expect(response.status[:code].to_i).to eq(200)
+    end
+
+  end
+
+  context 'list' do
+    it 'should work' do
+      data = @instance.list(q: 'test')
+      expect(data).to be_a(CrxPackageManager::PackageList)
+      expect(data.total).to eq(1)
+      expect(data.results).not_to be_nil
+      entry = data.results[0]
+      expect(entry).to be_a(CrxPackageManager::Package)
+      expect(entry.pid).to eq('my_packages:test:1.0.0')
+    end
+  end
+
+  context 'groups' do
+    it 'should work' do
+      data = @instance.groups(only_top_level: true)
+      expect(data).to be_a(CrxPackageManager::GroupList)
+      expect(data.groups).not_to be_nil
+      data.groups.each do |grp|
+        next if grp.name != 'my_packages'
+        expect(grp.title).to eq('my_packages')
+        expect(grp.count).to eq(1)
+        expect(grp.deep_count).to eq(1)
+      end
+    end
+  end
+
+  context 'thumbnail' do
+    it 'should work' do
+      data = @instance.thumbnail(path: path)
+      expect(data).to be_a(Tempfile)
+    end
+
+  end
+
+  context 'download' do
+    it 'should work' do
+      data = @instance.download(path: '/etc/packages/my_packages/test-1.0.0.zip')
+      expect(data).to be_a(Tempfile)
+    end
+
+  end
+
+  context 'service uninstall and remove' do
+    it 'should support uninstall' do
+      xml = @instance.service_get('uninst', name: 'test')
+      parsed = XmlSimple.xml_in(xml, { ForceArray: %r(param), KeyToSymbol: true, AttrToSymbol: true } )
+      sr = CrxPackageManager::ServiceResponse.new
+      sr = sr.build_from_hash(parsed)
+      response = sr.response
+      expect(response.status[:code].to_i).to eq(200)
+    end
+
+    it 'should support rm' do
+      xml = @instance.service_get('rm', name: 'test')
+      parsed = XmlSimple.xml_in(xml, { ForceArray: %r(param), KeyToSymbol: true, AttrToSymbol: true } )
+      sr = CrxPackageManager::ServiceResponse.new
+      sr = sr.build_from_hash(parsed)
+      response = sr.response
+      expect(response.status[:code].to_i).to eq(200)
+    end
+  end
+
+end

data/spec/api/default_api_spec.rb

@@ -3,7 +3,7 @@
 
 #API for interacting with the CRX Package Manager in AEM.
 
-OpenAPI spec version: 1.0.0
+OpenAPI spec version: 6.2.0
 Contact: bryan.stopp@gmail.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -38,20 +38,8 @@ describe 'DefaultApi' do
   end
 
   describe 'test an instance of DefaultApi' do
-    it 'should create an instact of DefaultApi' do
+    it 'should create an intact of DefaultApi' do
       expect(@instance).to be_instance_of(CrxPackageManager::DefaultApi)
     end
   end
-
-  # unit tests for list
-  # List all available packages.
-  # Returns a list of all available packages defined.
-  # @param [Hash] opts the optional parameters
-  # @return [InlineResponse200]
-  describe 'list test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
 end

data/spec/api/download_api_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+# unit tests for download
+# Download a package
+# Downloads the package at the specified path. Returns a Tempfile object.
+# @param [Hash] opts the optional parameters
+# @option opts [String] :path The path to the package to download.
+# @return [File]
+describe 'DefaultApi#download' do
+  before do
+    config = CrxPackageManager::Configuration.new
+    @instance = CrxPackageManager::DefaultApi.new(CrxPackageManager::ApiClient.new(config))
+  end
+
+  let(:dl) do
+    file = File.new(File.join(File.dirname(__FILE__), '..', 'files', 'test-1.0.0.zip'))
+    file
+  end
+
+  it 'should work' do
+    WebMock.reset!
+    path = '/etc/packages/my_packages/test-1.0.0.zip'
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+      :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/download.jsp"
+    ).with(
+      query: { path: path }
+    ).to_return(status: 200, body: dl, headers: { 'Content-Type' => 'application/octet-stream' })
+
+    data = @instance.download(path: path)
+    expect(data).to be_a(Tempfile)
+    expect(get_stub).to have_been_requested
+    data.delete
+  end
+
+  it 'should support config changes' do
+    WebMock.reset!
+    path = '/etc/packages/my_packages/test-1.0.0.zip'
+    @instance.api_client.config.configure do |c|
+      c.scheme = 'https'
+      c.host = 'notlocalhost'
+      c.base_path = '/contextroot/crx/packgr'
+      c.debugging = true
+    end
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+      :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/download.jsp"
+    ).with(
+      query: { path: path }
+    ).to_return(status: 200, body: dl, headers: { 'Content-Type' => 'application/octet-stream' })
+
+    data = @instance.download(path: path)
+    expect(data).to be_a(Tempfile)
+    expect(get_stub).to have_been_requested
+    data.delete
+
+  end
+
+  it 'should support failures' do
+    WebMock.reset!
+    path = '/etc/packages/my_packages/test-1.0.0.zip'
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+      :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/download.jsp"
+    ).with(
+      query: { path: path }
+    ).to_return(status: 404)
+
+    begin
+      @instance.download(path: path)
+    rescue CrxPackageManager::ApiError => e
+      expect(e).not_to be_nil
+      expect(e.code).to eq(404)
+    end
+
+    expect(get_stub).to have_been_requested
+  end
+
+  it 'should ignore other params' do
+    WebMock.reset!
+    path = '/etc/packages/my_packages/test-1.0.0.zip'
+    cfg = @instance.api_client.config
+    get_stub = stub_request(
+      :get, "#{cfg.scheme}://#{cfg.host}#{cfg.base_path}/download.jsp"
+    ).with(
+      query: { path: path }
+    ).to_return(status: 200, body: dl, headers: { 'Content-Type' => 'application/octet-stream' })
+
+    data = @instance.download(path: path, other_param: 'value')
+    expect(data).to be_a(Tempfile)
+    expect(get_stub).to have_been_requested
+    data.delete
+  end
+
+end