gunsru_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bdccbe683acc94ea15f3cd42ec067e85d585ca1
+  data.tar.gz: 9e478acd329a6aebdf70a56d9714ff2cfe9c690b
+SHA512:
+  metadata.gz: 11133cf817ba3f9bf4bd6a3d696fcff947ba612346d45a532191046fac56a686bbff3f1ceff13c5a3261eeb76a84cf26f85e142f15871134ea156d7ed9b74ae4
+  data.tar.gz: cea5f8913885cf7c2128d13b5de3284adaa00f7b815e3bcdee08ac216bd8681e907c451250019732ecefa29d537bdca6dde9f8f1182c93a31f520f3effe552a6

data/lib/gunsru_api.rb

@@ -0,0 +1,228 @@
+require 'net/http'
+#require 'logger'
+require 'json'
+
+##
+# This class allows to access forum.guns.ru via JSON API
+#
+# every instance method returns pair (HTTPResponse.code, Hash)
+#
+class GunsruAPI
+    ##
+    # Creates new JSON API accessor
+    #
+    def initialize(base_uri = "forum.guns.ru", api_uri = "/api/1.0/")
+        @base_uri = base_uri
+        @api_uri = api_uri
+        #@logger = Logger.new(STDOUT)
+        #@logger.formatter = proc do |sev, date, progname, msg|
+            #"#{msg}\n"
+        #end
+        @etags = {}
+    end
+
+    private
+
+    def getResponse(*args)
+        callerName = caller[0][/`.*'/][1..-2]
+        params = Hash[args.each_slice(2).to_a]
+        params[:format] = "json"
+        api_call = "#{@api_uri}#{callerName}?#{URI.encode_www_form(params)}"
+        http_req = Net::HTTP::Get.new(api_call)
+        http_req["If-None-Match"] = @etags[callerName]
+
+        #@logger.debug("sending HTTP::Get to #{api_call}, if-none-macth=#{@etags[callerName]}")
+        http = Net::HTTP.new(@base_uri)
+        http_resp = http.request(http_req)
+        #@logger.debug("got HTTPResponse, code = #{http_resp.code}, etag=#{http_resp["etag"]}")
+        @etags[callerName] = http_resp["etag"]
+        code = http_resp.code.to_i
+        # sometimes gunsru sends bad UTF-8, and it breaks JSON parser
+        # i tried Iconv and String.encode, but was not able to solve this problem
+        result = JSON.parse(http_resp.body.force_encoding('UTF-8').gsub(/[^[:print:]]/u, ''))["result"] if code == 200
+        return code, result
+    end
+
+    public
+
+    ##
+    # Arguments: none
+    # Cacheable: yes
+    # Returns: hash
+    #   {
+    #     timestamp: <unixtime>,
+    #     categories: [ {
+    #       type: "category",
+    #       title: <string>,
+    #       id: <integer>,
+    #       sections: [ {
+    #         type: <string>,
+    #         title: <string>,
+    #         id: <integer>,
+    #         modificationTime: <unixtime>,
+    #         categoryId: <integer>
+    #   }]}]}
+    #
+    def getAllCategories()
+        getResponse()
+    end
+
+    ##
+    # Arguments: id, from, to
+    # Cacheable: yes
+    # Returns: hash
+    #   {
+    #     timestamp: <unixtime>,
+    #     section_id: <unixtime>,
+    #     topics: [ {
+    #       type: "topic",
+    #       topic_type: <string>,
+    #       title: <string>,
+    #       id: <integer>,
+    #       element_number: <integer>,
+    #       modificationTime: <unixtime>,
+    #       postCount: <integer>,
+    #       author: <string>,
+    #       lastPost: <string> (author)
+    #   }]}
+    #
+    def getTopicsBySectionId(id, from=0, to=20)
+        getResponse('id', id, 'from', from, 'to', to)
+    end
+
+    ##
+    # Arguments: from, to
+    # Cacheable: yes
+    # Returns: hash
+    #   {
+    #     timestamp: <unixtime>,
+    #     topics: [ {
+    #       type: "topic",
+    #       title: <string>,
+    #       id: <integer>,
+    #       modificationTime: <unixtime>,
+    #       postCount: <integer>,
+    #       author: <string>,
+    #       lastPost: <string> (author)
+    #   }]}
+    #
+    def getActiveTopics(from=0, to=20)
+        getResponse('from', from, 'to', to)
+    end
+
+    ##
+    # Arguments: id, direction, count. Optional: number, start_msg_id
+    # Cacheable: yes
+    # Returns: hash
+    #   {
+    #     timestamp: <unixtime>,
+    #     topic_id: <integer>,
+    #     messages: [ {
+    #       type: "post",
+    #       body: <string>,
+    #       id: <integer>,
+    #       element_number: <integer>,
+    #       createTime: <unixtime>,
+    #       author: { [
+    #         nickname: <string>,
+    #         id: <integer>,
+    #         userpic: [ { ... }],
+    #       ]}
+    #   }]}
+    #
+    def getPostsByTopicId(id, direction=1, count=1024)
+        getResponse('id', id, 'direction', direction, 'count', count)
+    end
+
+    def getLinkedSectionsById(*args)
+        return -1, {}
+        getResponse
+    end
+    def addTopicToFavourites()
+        return -1, {}
+        getResponse
+    end
+    def getLinkedTopicsById()
+        return -1, {}
+        getResponse
+    end
+    def addMessageToTopic()
+        return -1, {}
+        getResponse
+    end
+    def getSectionById()
+        return -1, {}
+        getResponse
+    end
+    def getTopicById()
+        return -1, {}
+        getResponse
+    end
+    def getPostById()
+        return -1, {}
+        getResponse
+    end
+
+
+    # news & last topics
+    def getLastTopics()
+        return -1, {}
+        getResponse
+    end
+    def getNews()
+        return -1, {}
+        getResponse
+    end
+
+    # personal messages
+    def getUserProfileById()
+        return -1, {}
+        getResponse
+    end
+    def getConversations()
+        return -1, {}
+        getResponse
+    end
+    def getConversationById()
+        return -1, {}
+        getResponse
+    end
+    def getFullMessageById()
+        return -1, {}
+        getResponse
+    end
+    def getNewMessageCount()
+        return -1, {}
+        getResponse
+    end
+
+    # favorite sections manipulation
+    def getFavoritesSections()
+        return -1, {}
+        getResponse
+    end
+    def getFavoriteTopics()
+        return -1, {}
+        getResponse
+    end
+    def removeTopicFromFavourites()
+        return -1, {}
+        getResponse
+    end
+    # push notifications
+    def registerIosDevice()
+        return -1, {}
+        getResponse
+    end
+    def unRegisterIosDevice()
+        return -1, {}
+        getResponse
+    end
+    def logout()
+        return -1, {}
+        getResponse
+    end
+
+end
+
+

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: gunsru_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Burkov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: only few functions are supported
+email: a.p.burkov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gunsru_api.rb
+homepage: http://github.com/burkov/gunsru_api
+licenses:
+- LGPL
+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.1.8
+signing_key: 
+specification_version: 4
+summary: API for guns.ru forum
+test_files: []