A GitHub account searcher
JSON (Java Script Object Notation) adalah format atau sintaks yang digunakan untuk melakukan penyimpanan ataupun pertukaran data. JSON ditulis dalam bentuk teks yang dapat dibaca oleh manusia dan digunakan sebagai representasi struktur data dan objek.
Ketika melakukan pertukaran data antara browser dan server, data hanya dapat berupa teks. Objek JavaScript dapat dikonversikan ke dalam JSON dan dikirim ke server, maupun sebaliknya.
Data yang tersimpan dalam objek JavaScript dikonversikan ke JSON, lalu dikirim ke server.
Data yang tersimpan dalam JSON dikonversikan ke objek JavaScript.
Format data yang digunakan untuk penyimpanan adalah teks, sehingga dapat dibaca dan digunakan oleh bahasa pemrograman manapun (language independent).
REST (Representational State Transfer) adalah arsitektur berbasis standar web dan menggunakan HTTP Protocol untuk melakukan komunikasi data. REST berputar di sekitar sumber di mana setiap komponen dari sumber tersebut juga merupakan sumber dan sumber diakses oleh sebuah antarmuka umum menggunakan metode standar HTTP. Dalam arsitektur REST, REST Server bertugas untuk menyediakan akses ke sumber, sedangkan REST Client bertugas untuk mengakses dan membawakan sumber. Setiap sumber diidentifikasi dengan URI (Uniform Resource Identifier) atau ID global. Beberapa representasi dari sumber yang digunakan oleh REST adalah teks, JSON, dan XML. Saat ini, format yang paling sering digunakan dalam web service adalah JSON.
- GET: hanya dapat membaca sumber.
- PUT: digunakan untuk menciptakan sumber baru.
- DELETE: digunakan untuk menghapus sumber.
- POST: digunakan untuk memperbarui sumber yang sudah ada atau menciptakan sumber baru.
- OPTIONS: digunakan untuk memperoleh operasi yang didukung oleh suatu sumber.
Web service adalah sebuah kumpulan dari protokol terbuka dan standar yang digunakan untuk melakukan pertukaran data melalui aplikasi atau sistem. Aplikasi perangkat lunak yang ditulis dalam berbagai bahasa pemrograman dan berjalan pada bermacam-macam platform dapat menggunakan web service untuk melakukan pertukaran data melalui jaringan komputer seperti internet dengan memperlakukannya seperti proses dalam sebuah komputer. Web service yang berbasis arsitektur REST dikenal sebagai RESTful Web Service. Web service jenis tersebut menggunakan metode HTTP untuk implementasi konsep dari arsitektur REST. RESTful Web Service biasa mendefinisikan URI, yaitu service yang menyediakan representasi sumber seperti JSON dan sekumpulan metode HTTP.
API (Application Program Interface) yang menyediakan kelas-kelas yang berhubungan dengan main.test.model domain dari GitHub, operasi-operasi yang dimiliki dan didefinisikan sebagai metode, dan referensi-referensi objek.
Akses yang dilakukan menggunakan HTTPS, dan diakses lewat https://api.github.com. Semua data dikirim dan diterima sebagai JSON. Blank field -> null (bukannya dihapus). Timestamp -> ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).
Saat pengguna memanggil daftar sumber, respon yang diberikan berisi himpunan bagian dari atribut sumber tersebut. Tidak semua atribut diberikan oleh API. Hal ini dikarenakan secara komputasi pemanggilan atribut-atribut tersebut mahal, sehingga untuk meningkatkan performa, hanya dilakukan pemanggilan untuk atribut-atribut utama.
Banyak metode yang menggunakan parameter opsional.
- GET requests: parameter yang tidak dispesifikkan sebagai sebuah segmen dalam sebuah path dapat disampaikan sebagai HTTP query string parameter.
- POST, PUT, DELETE, PATCH requests: parameter yang tidak termasuk dalam URL harus dienkode sebagai JSON dengan tipe konten sebagai 'application/json'
- Mengirimkan JSON yang invalid akan menghasilkan 400 Bad Request.
- Mengirimkan nilai JSON dengan tipe yang salah akan menghasilkan 400 Bad Request.
- Mengirimkan field yang invalid akan menghasilkan 422 Unprocessable Entity.
Respon dari redirect akan mengandung Location header field yang memiliki URI dari sumber yang dituju oleh pengulangan request dari client.
- 301: permanent redirection, menggunakan URI baru untuk request ke depannya.
- 302, 307: temporary redirection, menggunakan URI yang sama untuk request ke depannya.
- HEAD: dapat digunakan untuk mendapatkan HTTP header info dari sumber manapun.
- GET: mendapat sumber.
- POST: membuat sumber.
- PATCH: memperbarui sumber dengan sebagian dari data JSON. Setiap sumber yang bersangkutan memiliki atribut title dan body. PATCH request dapat menerima satu atau lebih atribut untuk memperbarui sumber.
- PUT: menggantikan sumber atau koleksi.
- DELETE: menghapus sumber.
GitHub Hunter provides search for GitHub user accounts in either specified fields only (username, e-mail, and full name) or all of them. Search results can be filtered by the number of repositories or/and the number of followers owned.
It also contains disclaimer message to avoid piracy and plagiarism.
Queries needed can be filled through text field, dropdown list, and checkbox. However, keyword must be filled if user wants to proceed to the search results, otherwise it will show warning with a pop-up window. Category determines the fields used for searching. Pursued category for search can be selected by choosing an available option from the dropdown list.
By default, search does not use filter to restrict the results. So if user wants the results to be filtered, the specified checkbox has to be ticked. The operators used for filter are < (less than), <= (less than or equal), > (more than), and >= (more than or equal). Repository filter and followers filter text fields can only receive integer as input. User will be informed about it with a tooltip that appears when the cursor is hovering above the either of them.
GitHub Hunter will show a pop-up window to inform the number of users who match the queries.
The left panel will show the list of user identities. The right panel will show a quick summary of repositories of the selected user. When the repository is clicked, user will be directed to the specified GitHub repository via web browser. If the selection moves to another user, the repository summary shown will also change to match repositories data of the currently selected user.