piwigo-api 0.1.0

checksums.yaml

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

data/.github/workflows/gempush.yml

@@ -0,0 +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}}

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/.vscode/launch.json

@@ -0,0 +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"
+        }
+    ]
+}

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 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]

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in piwigo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    piwigo-api (0.1.0)
+      http (~> 4.2)
+      logger (~> 1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.11.2-x64-mingw32)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.2.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    logger (1.4.1)
+    minitest (5.13.0)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  piwigo-api!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Adrian Gilbert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Piwigo-API
+
+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/piwigo`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'piwigo-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install piwigo-api
+
+## Usage
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kkdad/piwigo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "piwigo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/piwigo/session.rb

@@ -0,0 +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
+end

data/lib/piwigo/version.rb

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

data/lib/piwigo.rb

@@ -0,0 +1,6 @@
+require "piwigo/version"
+
+module Piwigo
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/main.rb

@@ -0,0 +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
+
+puts "END"

data/piwigo-api.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "piwigo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "piwigo-api"
+  spec.version       = Piwigo::VERSION
+  spec.authors       = ["Adrian Gilbert"]
+  spec.email         = ["adrian@gilbert.ca"]
+
+  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.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"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "logger", "~>1.4"
+  spec.add_runtime_dependency "http", "~>4.2"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: piwigo-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Gilbert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Ruby gem to interact with the Piwigo API
+email:
+- adrian@gilbert.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gempush.yml"
+- ".gitignore"
+- ".travis.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/piwigo.rb
+- lib/piwigo/session.rb
+- lib/piwigo/version.rb
+- main.rb
+- piwigo-api.gemspec
+homepage: https://github.com/kkdad/ruby-piwigo
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby gem to interact with the Piwigo API
+test_files: []