jsb_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05160b9a8640c2687fe4b027940c9258dc5ccb4b
+  data.tar.gz: aa1668409ed1e21cdf7d3e5145cf1ba556e9127e
+SHA512:
+  metadata.gz: 128a0fcc434e42d258e199d711beaf487ebaaadaf2aeba47f3f0fd96392e053c135845e75065610080a54736712df59dd91a63c5b2f7bb10d6410cbc8a6c1f87
+  data.tar.gz: 2943cd46812e1b94e2bf7b872bcd2aa88593f0119640b90ec7ecfe2352d9b7dbb7e4d5eaee30f94a6897a7a53202d1d66eb95afb0285b24383a1b75dd8e851b5

data/jsb_client/ruby/v1/lib/jsb.rb

@@ -0,0 +1,151 @@
+require 'rest_client'
+require 'json'
+
+# Client to connect on Definity Journal Service Bus (JSB) Server.
+# See more in http://jsb.definitysolutions.com
+class JSB
+
+    # URL for API
+    API_URL = 'http://jsb.definitysolutions.com/api/1.0'
+
+    # initialize with api_key.
+    #
+    # Arguments:
+    #   api_key: (String) is a code generate by application hosted on JSB server.
+    def initialize(api_key)
+        @api_key = api_key
+        @headers = { :"JSB-Api-Key" => api_key }
+        @statistics = JSB::Statistics.new(self)
+
+        @api = RestClient::Resource.new(API_URL, :content_type => "application/json", :headers => @headers)
+    end
+
+    # Return a list of journals.
+    def journals
+        parse(@api["/journals"].get(:accept => :json))
+    end
+
+    # Return a specific journal.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    def journal(journal_id)
+        parse(@api["/journals/#{journal_id}"].get(:accept => :json))
+    end
+
+    # Syncronize journal with OJS.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    #   force: (String) if force is true, will force update all data.
+    def journal_sync(journal_id, force = false)
+        parse(@api["/journals/#{journal_id}/sync"].get(:force => force, :accept => :json))
+    end
+
+    # Return a list of issue from a journal.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    def issues(journal_id)
+        parse(@api["/journals/#{journal_id}/issues"].get(:accept => :json))
+    end
+
+    # Return a list of articles from a issue.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    #   issue_id: (Integer) id of issue.
+    def articles(journal_id, issue_id)
+        parse(@api["/journals/#{journal_id}/issues/#{issue_id}/articles"].get(:accept => :json))
+    end
+
+    # Return a specific article.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    #   issue_id: (Integer) id of issue.
+    #   article_id: (Integer) id of article.
+    def article(journal_id, issue_id, article_id)
+        parse(@api["/journals/#{journal_id}/issues/#{issue_id}/articles/#{article_id}"].get(:accept => :json))
+    end
+
+    # Return a list of authors.
+    def authors
+        parse(@api["/authors"].get(:accept => :json))
+    end
+
+    # Return a list of authors from a journal.
+    #
+    # Arguments:
+    #   journal_id: (Integer) id of journal.
+    def journal_authors(journal_id)
+        parse(@api["/journals/#{journal_id}/authors"].get(:accept => :json))
+    end
+
+    # Return a list of articles from author.
+    #
+    # Arguments:
+    #   author_id: (Integer) id of author.
+    def author_articles(author_id)
+        parse(@api["/authors/#{author_id}/articles"].get(:accept => :json))
+    end
+
+    # Return a group of methods of statistics.
+    def statistics
+        @statistics
+    end
+
+    # Return a API REST client resource.
+    def api
+        @api
+    end
+
+    # Parse JSON to hash.
+    def parse(obj)
+        JSON.parse(obj)
+    end
+
+    # Group of statistics methods.
+    class Statistics
+        def initialize(parent)
+            @parent = parent
+        end
+
+        # Register statistics for specific resource.
+        #
+        # Arguments:
+        #   params: (Hash)
+        #       journal_id: (Integer) id of journal.
+        #       issue_id: (Integer) id of issue.
+        #       article_id: (Integer) id of article.
+        def register(params = {})
+            url_params = params_to_url(params)
+
+            @parent.api["/statistics/register?#{url_params}"].put :accept => :json
+        end
+
+        # View statistics for specifc resource.
+        #
+        # Arguments:
+        #   params: (Hash)
+        #       journal_id: (Integer) id of journal.
+        #       issue_id: (Integer) id of issue.
+        #       article_id: (Integer) id of article.
+        def view(params = {})
+            url_params = params_to_url(params)
+
+            @parent.parse(@parent.api["/statistics/view?#{url_params}"].get(:accept => :json))
+        end
+
+        private
+
+            # convert hash params to url parameters.
+            def params_to_url(params)
+                url_params = ''
+                url_params += '&journal_id=' + params[:journal_id].to_s if params[:journal_id]
+                url_params += '&issue_id=' + params[:issue_id].to_s if params[:issue_id]
+                url_params += '&article_id=' + params[:article_id].to_s if params[:article_id]
+            end
+    end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: jsb_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Definity Solutions
+- David Sobreira Gouvea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: A simple client to connect with Definity Journal Service Bus Server
+email: developer@definitysolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- jsb_client/ruby/v1/lib/jsb.rb
+homepage: http://jsb.definitysolutions.com
+licenses:
+- Apache
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Journal Service Bus (JSB) Client
+test_files: []