piwigo-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bb322785be6cd6dc7badc8322d940011e3fda51d67ae22a633ce466c083b31b
-  data.tar.gz: fa6d175bb4adc25dbb30f8721aaceb4664e9a4b78c17ddbc2dee6c4729d0e60e
+  metadata.gz: 1f0808e4bf6d4c5d9800c348b749a34b812d137a7268f76954895089127b0dc4
+  data.tar.gz: bba4ab540b38076e7c32e1e6d2b776e15a135ffd59a2d5f8b0e76c33b5d1ece9
 SHA512:
-  metadata.gz: 9b9c04113aca32b50c383718303a682d0680472b25ce05dc28ab713930baf59d7b0b65e6cfea75e3e35bdd3ae122073a7ea49b97e9ab81b0ca10b29846b864d7
-  data.tar.gz: 1cfe5a89b68ce944fb06f5c8d311bff2e41b40babe5c65534014cea268d68163f33775a2af91f7f322ee79a3385b2601cf1dd6c3c339d3416062997c5fc149c3
+  metadata.gz: 0b5f0499e2d5f445b023f3252d6b4d10802e5374c19be951b872d59bc5e64e33b7c0f85c1dffc3e3503b4b98ff0faa71928e36d0223f540b73530763331b1740
+  data.tar.gz: 8d37ee9536426d15f36c4c25ca12cd1c0019819410af4332bc6515c9f9a9dc57329532fdd8be0e89c24581993ea1766a129ac4738e6b187b133e2c69bb35ebcf

data/.github/workflows/gempush.yml

@@ -1,44 +1,44 @@
-name: Ruby Gem
-
-on:
-  pull_request:
-    branches:
-      - master
-  push:
-    branches:
-      - master
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        version: 2.6.x
-
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
-        OWNER: KKDad
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+name: Ruby Gem
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        version: 2.6.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
+        OWNER: KKDad
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.vscode/launch.json

@@ -1,15 +1,15 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-    
-        {
-            "name": "Debug Local File",
-            "type": "Ruby",
-            "request": "launch",
-            "program": "${workspaceRoot}/main.rb"
-        }
-    ]
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+    
+        {
+            "name": "Debug Local File",
+            "type": "Ruby",
+            "request": "launch",
+            "program": "${workspaceRoot}/main.rb"
+        }
+    ]
 }

data/CHANGELOG.md

@@ -1,7 +1,12 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+0.1.1 - 2019-11-16 
+- Initial Version, supports login/logout against a piwigo server
+- Fixing spec consistency issues

data/lib/piwigo/session.rb

@@ -1,76 +1,76 @@
-require 'net/http'
-require 'uri'
-require 'json'
-require 'logger'
-
-module Piwigo
-    # Class to hold the Piwigo session the rest of the API needs to pass in order to access the API
-    class Session
-        
-        def session_id
-            @session_id
-        end
-            
-        # Instantion a new  Session object
-        # @param [Logger] logger logger to output debug messages to (Optional)
-        def initialize(logger: nil)
-            @session_id=nil
-            @uri=nil       
-            @logger = logger || Logger.new(STDOUT)     
-        end
-
-        # Log into the piwigo API and grab the session id for subsequent calls.
-        # @param [string] piwigo - host to connect to. Can be fqdn or ip. 
-        # @param [string] username - user to connect as
-        # @param [string] password - password for user
-        # @param [boolean] https - Use HTTPS?
-        def login(host, username, password, https: true)
-
-            raise "host should not be nil" if host.nil?
-            raise "username should not be nil" if username.nil?
-
-            begin
-            
-                @uri = https ? URI::HTTPS.build(host: host, path: "/ws.php", query: "format=json") :
-                               URI::HTTP.build(host: host, path: "/ws.php", query: "format=json")                 
-            
-                # Create the HTTP objects
-                http = Net::HTTP.new(@uri.host, @uri.port)
-                request = Net::HTTP::Post.new(@uri.request_uri)
-                request.body = "method=pwg.session.login&username=#{username}&password=#{password}"
-                
-                # Send the request
-                response = http.request(request)    
-            
-                if response.code == '200'
-                    @logger.info "Login succeeded: #{response.body}"
-                    @session_id = response.response['set-cookie'].split(';').select { |i| i.strip.start_with? "pwg_id" }
-                    return true
-                else
-                    @logger.error "Login failed: #{response.body}"
-                    @session_id = nil
-                    @uri = nil
-                end
-
-            rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-                    @logger.error "Login failed: #{e.messages}"
-            end
-            false    
-        end   
-    
-        def logout
-            raise "login must be successfully called before logout" if @uri.nil?
-
-            # Create the HTTP objects
-            http = Net::HTTP.new(@uri.host, @uri.port)
-            request = Net::HTTP::Get.new(@uri.request_uri + "&method=pwg.session.logout")
-            request['Cookie'] = @session_id
-            
-            # Send the request
-            response = http.request(request)               
-            @logger.info "Logout succeeded: #{response.body}" if response.code == '200'    
-            @session_id = nil
-            @uri = nil
-        end
-    end
+require 'net/http'
+require 'uri'
+require 'json'
+require 'logger'
+
+module Piwigo
+    # Class to hold the Piwigo session the rest of the API needs to pass in order to access the API
+    class Session
+        
+        def session_id
+            @session_id
+        end
+            
+        # Instantion a new  Session object
+        # @param [Logger] logger logger to output debug messages to (Optional)
+        def initialize(logger: nil)
+            @session_id=nil
+            @uri=nil       
+            @logger = logger || Logger.new(STDOUT)     
+        end
+
+        # Log into the piwigo API and grab the session id for subsequent calls.
+        # @param [string] piwigo - host to connect to. Can be fqdn or ip. 
+        # @param [string] username - user to connect as
+        # @param [string] password - password for user
+        # @param [boolean] https - Use HTTPS?
+        def login(host, username, password, https: true)
+
+            raise "host should not be nil" if host.nil?
+            raise "username should not be nil" if username.nil?
+
+            begin
+            
+                @uri = https ? URI::HTTPS.build(host: host, path: "/ws.php", query: "format=json") :
+                               URI::HTTP.build(host: host, path: "/ws.php", query: "format=json")                 
+            
+                # Create the HTTP objects
+                http = Net::HTTP.new(@uri.host, @uri.port)
+                request = Net::HTTP::Post.new(@uri.request_uri)
+                request.body = "method=pwg.session.login&username=#{username}&password=#{password}"
+                
+                # Send the request
+                response = http.request(request)    
+            
+                if response.code == '200'
+                    @logger.info "Login succeeded: #{response.body}"
+                    @session_id = response.response['set-cookie'].split(';').select { |i| i.strip.start_with? "pwg_id" }
+                    return true
+                else
+                    @logger.error "Login failed: #{response.body}"
+                    @session_id = nil
+                    @uri = nil
+                end
+
+            rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+                    @logger.error "Login failed: #{e.messages}"
+            end
+            false    
+        end   
+    
+        def logout
+            raise "login must be successfully called before logout" if @uri.nil?
+
+            # Create the HTTP objects
+            http = Net::HTTP.new(@uri.host, @uri.port)
+            request = Net::HTTP::Get.new(@uri.request_uri + "&method=pwg.session.logout")
+            request['Cookie'] = @session_id
+            
+            # Send the request
+            response = http.request(request)               
+            @logger.info "Logout succeeded: #{response.body}" if response.code == '200'    
+            @session_id = nil
+            @uri = nil
+        end
+    end
 end

data/lib/piwigo/version.rb

@@ -1,3 +1,3 @@
 module Piwigo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/main.rb

@@ -1,8 +1,8 @@
-require_relative 'lib/piwigo/session'
-
-puts "BEGIN"
-session = Piwigo::Session.new
-session.login('10.100.230.78', 'Adrian', 'secret', https: false)
-session.logout
-
+require_relative 'lib/piwigo/session'
+
+puts "BEGIN"
+session = Piwigo::Session.new
+session.login('10.100.230.78', 'Adrian', 'secret', https: false)
+session.logout
+
 puts "END"

data/piwigo-api.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Ruby gem to interact with the Piwigo API}
   spec.description   = %q{Ruby gem to interact with the Piwigo API}
-  spec.homepage      = "https://github.com/kkdad/ruby-piwigo"
+  spec.homepage      = "https://github.com/kkdad/piwigo-api"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/kkdad/piwigo-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/kkdad/piwigo-ruby/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/kkdad/piwigo-api"
+  spec.metadata["changelog_uri"] = "https://github.com/kkdad/piwigo-api/CHANGELOG.md"
 
   # 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piwigo-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adrian Gilbert
@@ -104,13 +104,13 @@ files:
 - lib/piwigo/version.rb
 - main.rb
 - piwigo-api.gemspec
-homepage: https://github.com/kkdad/ruby-piwigo
+homepage: https://github.com/kkdad/piwigo-api
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/kkdad/ruby-piwigo
-  source_code_uri: https://github.com/kkdad/piwigo-ruby
-  changelog_uri: https://github.com/kkdad/piwigo-ruby/CHANGELOG.md
+  homepage_uri: https://github.com/kkdad/piwigo-api
+  source_code_uri: https://github.com/kkdad/piwigo-api
+  changelog_uri: https://github.com/kkdad/piwigo-api/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: